lanyard-wrapper

Lanyard Wrapper

Fully-typed Lanyard API wrapper for JavaScript/TypeScript (in browser environment)

Looking for Node.js? Check out node-lanyard-wrapper

Installation

NPM

npm i lanyard-wrapper

Yarn

yarn add lanyard-wrapper

CDN

<script src="https://cdn.jsdelivr.net/npm/lanyard-wrapper/dist/index.browser.js"></script>

Usage

Browser

Connecting with WebSocket

<script src="https://cdn.jsdelivr.net/npm/lanyard-wrapper/dist/index.browser.js"></script>

<script type="text/javascript">
    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 = LanyardWrapper.connectWebSocket("USER_ID", onUpdate, onError);
</script>

OR Using the REST API

<script src="https://cdn.jsdelivr.net/npm/lanyard-wrapper/dist/index.browser.js"></script>

<script type="text/javascript">
    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);
            });
</script>

CommonJS

Connecting with WebSocket

const LanyardWrapper = require("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 = LanyardWrapper.connectWebSocket("USER_ID", onUpdate, onError);

OR Using the REST API

const LanyardWrapper = require("lanyard-wrapper");

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);
    });

ES Modules / TypeScript

Connecting with WebSocket

import { connectWebSocket } from "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

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