https://github.com/seanpray/solidjs-lanyard
lanyard api for solidjs
https://github.com/seanpray/solidjs-lanyard
Last synced: about 1 month ago
JSON representation
lanyard api for solidjs
- Host: GitHub
- URL: https://github.com/seanpray/solidjs-lanyard
- Owner: seanpray
- License: mit
- Created: 2022-09-13T22:20:36.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-09-14T03:05:58.000Z (over 2 years ago)
- Last Synced: 2025-03-26T22:03:17.984Z (about 2 months ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/solidjs-lanyard
- Size: 16.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Use Lanyard API in your SolidJS application!
- using yarn: `yarn add solidjs-lanyard`
- using npm: `npm i solidjs-lanyard`
Checkout [types.ts](https://github.com/notseanray/solid-lanyard/blob/master/src/types.ts) for all the fields
This package is not tested very well, if you encounter issues please report them here: [solidjs-lanyard](https://github.com/notseanray/solid-lanyard)
websocket example component
```javascript
import { useLanyardWS } from "solidjs-lanyard";
import { createStore } from "solid-js/store";
const DISCORD_ID = "566444484850745351";
const Discord = () => {
const [user, setUser] = createStore({});
// Your discord ID, store setter, keep alive interval for websocket
useLanyardWS(DISCORD_ID, setUser, 1000);
return (
<>
loading!
{user()?.discord_user?.username}
>
);
};
```
REST API example component
```javascript
import { useLanyardREST } from "solidjs-lanyard";
import { createResource } from "solid-js";
const DISCORD_ID = "566444484850745351";
const Discord = () => {
const [user] = createResource(DISCORD_ID, useLanyardREST);
return (
<>
loading!
{user()?.discord_user?.username}
>
);
};
```