https://github.com/brokiem/node-lanyard-wrapper
Fully-typed Lanyard API wrapper for Node.js
https://github.com/brokiem/node-lanyard-wrapper
Last synced: about 2 months ago
JSON representation
Fully-typed Lanyard API wrapper for Node.js
- Host: GitHub
- URL: https://github.com/brokiem/node-lanyard-wrapper
- Owner: brokiem
- License: mit
- Created: 2023-02-22T04:39:55.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-02-22T07:44:57.000Z (over 2 years ago)
- Last Synced: 2025-03-13T13:51:18.524Z (3 months ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/node-lanyard-wrapper
- Size: 38.1 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node-lanyard-wrapper
Fully-typed Lanyard API wrapper for Node.js
[](https://www.npmjs.com/package/node-lanyard-wrapper)
[](https://www.npmjs.com/package/node-lanyard-wrapper)
## Features
- Fully-typed
- Supports both WebSocket and REST API
- Supports fetching data for multiple users at once
- Supports fetching data for a single user
## Installation
### NPM
```bash
npm i node-lanyard-wrapper
```
### Yarn
```bash
yarn add node-lanyard-wrapper
```
## Usage
### Connecting with WebSocket
```js
import { connectWebSocket } from 'node-lanyard-wrapper';
function onUpdate(data) {
// data is a Lanyard data object
console.log(data);
}
function onError(err) {
// err is an error object
console.error(err);
}
const ws = connectWebSocket('USER_ID', onUpdate, onError);
```
### OR Using the REST API
```js
import { fetchUserData, fetchUserDataForMultipleUsers } from 'node-lanyard-wrapper';
// Fetching data for a user
fetchUserData('USER_ID').then((data) => {
// data is a Lanyard data object
console.log(data);
});
// Fetching data for multiple users
fetchUserDataForMultipleUsers(['USER_ID_1', 'USER_ID_2']).then((data) => {
// data is an array of Lanyard data objects
console.log(data);
});
```
## Contributing
Pull requests are welcome.
## License
[MIT](https://choosealicense.com/licenses/mit/)