https://github.com/brokiem/lanyard-wrapper
Fully-typed Lanyard API wrapper for JavaScript/TypeScript (browser env)
https://github.com/brokiem/lanyard-wrapper
Last synced: 3 months ago
JSON representation
Fully-typed Lanyard API wrapper for JavaScript/TypeScript (browser env)
- Host: GitHub
- URL: https://github.com/brokiem/lanyard-wrapper
- Owner: brokiem
- License: mit
- Created: 2023-02-22T05:09:17.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2023-10-30T01:43:32.000Z (over 1 year ago)
- Last Synced: 2025-02-28T10:44:16.112Z (3 months ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/lanyard-wrapper
- Size: 129 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Lanyard Wrapper
Fully-typed Lanyard API wrapper for JavaScript/TypeScript (in browser environment)
[](https://www.npmjs.com/package/lanyard-wrapper)
[](https://www.npmjs.com/package/lanyard-wrapper)
Looking for Node.js version? Check out [node-lanyard-wrapper](https://github.com/brokiem/node-lanyard-wrapper)
## Features
- Fully-typed
- Supports WebSocket connection
- Supports REST API
- Supports managing Lanyard KV
## Installation
#### NPM
```bash
npm i lanyard-wrapper
```
#### Yarn
```bash
yarn add lanyard-wrapper
```
#### CDN
```html
```
## Usage
Check out [Lanyard Wrapper Documentation](https://brokiem.is-a.dev/lanyard-wrapper/) for more information about the data object.
### Browser
#### Connecting with WebSocket
```html
function onUpdate(data) {
// data is a Lanyard data object
console.log(data);
}
LanyardWrapper.connectWebSocket("USER_ID", onUpdate)
.then(ws => {
// ws is a WebSocket object
console.log(ws);
})
.catch(err => {
console.error(err);
});
```
#### OR Using the REST API
```html
LanyardWrapper.fetchUserData("USER_ID")
.then(data => {
console.log(data);
})
.catch(err => {
console.error(err);
});
LanyardWrapper.fetchUserDataForMultipleUsers(["USER_ID_1", "USER_ID_2"])
.then(data => {
console.log(data);
})
.catch(err => {
console.error(err);
});
```
### CommonJS / ES Modules / TypeScript
#### Connecting with WebSocket
```ts
// Use require() if you are using CommonJS
const LanyardWrapper = require("lanyard-wrapper");
// Use import if you are using ES Modules
import { connectWebSocket } from "lanyard-wrapper";
function onUpdate(data) {
// data is a Lanyard data object
console.log(data);
}
connectWebSocket("USER_ID", onUpdate)
.then(ws => {
// ws is a WebSocket object
console.log(ws);
})
.catch(err => {
console.error(err);
});
```
#### OR Using the REST API
```ts
// Use require() if you are using CommonJS
const LanyardWrapper = require("lanyard-wrapper");
// Use import if you are using ES Modules
import { fetchUserData, fetchUserDataForMultipleUsers } from "lanyard-wrapper";
fetchUserData("USER_ID")
.then(data => {
console.log(data);
})
.catch(err => {
console.error(err);
});
fetchUserDataForMultipleUsers(["USER_ID_1", "USER_ID_2"])
.then(data => {
console.log(data);
})
.catch(err => {
console.error(err);
});
```
## Contributing
Pull requests are welcome.
## License
[MIT](https://choosealicense.com/licenses/mit/)