Releases: junlarsen/league-connect
Releases · junlarsen/league-connect
Initial Release
The initial release of the connector. Accidentally pushed wrong readmes to NPM which is why there's a version jump.
Authentication Polling and Typed Requests
This is a pre-release for 5.x.x which features properly typed http requests for TypeScript and an option for polling the authentication function until a LeagueClientUx process has been found.
Added
request<T>
will now properly return aResponse<T>
whose.json()
method will return aT
.authenticate
now has options toawaitConnection
, searching until a LeagueClientUx has been found.- Running the library in an environment which the LeagueClient cannot run on will now throw a
InvalidPlatformError
upon calls toauthenticate
.
Fixes
- Fixed a bug where LeagueWebSocket's subscriptions would attach twice upon registration
- Removed unnecessary
fs-extra
dependency
Breaking Changes
Credentials
interface no longer returns HTTP protocol, process pid or process name.- This is because the new implementation uses the process command line arguments to retrieve password/port instead of the lockfile process. (see https://www.hextechdocs.dev/lol/lcuapi/6.getting-started-with-the-lcu-api#getting-the-port-number-and-the-password)
- LeagueWebSocket no longer has a
getListeners()
method, instead, thesubscriptions
property is a public.- The properly is no longer an object, the implementation now uses a Map.
WebSocket rewrite + improvements
Rewrites and improves the entire WebSocket connection.
Breaking Changes
connect()
renamed toauth()
getWebSocket
renamed toconnect()
sendRequest
renamed torequest
New Features
- Subscription to events via custom WebSocket
LeagueWebSocket.subscribe
LeagueWebSocket.unsubscribe
1.1.0 - Translate to TypeScript
Rewritten entire library in typescript