Skip to content
Tiny package for connecting with the League Client APIs. Inspired by lcu-connector
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.gitignore
README.md
package.json
tsconfig.json

README.md

LeagueConnect

LeagueConnect is a basic module for connecting to the League Client APIs, heavily inspired by LCU-Connector by Pupix.

Usage

Retrieve the credentials for the API:

import Connector from 'league-connect';

// Extracts the entire lockfile into an object.
const credentials = await Connector.connect();

Connect to the Client WebSocket:

import Connector from 'league-connect';

const ws = await Connector.getWebSocket();

Send a request to any API:

import Connector from 'league-connect';

const credentials = await Connector.connect();

// If you're sending anything with a body, use the body field.
const response = await Connector.sendRequest({
    url: 'lol-summoner/v1/current-summoner',
    method: 'GET'
    /* body: {} */
}, credentials);
```
You can’t perform that action at this time.