Have ideas to improve npm?Join in the discussion! »

    @pluewallet/plue

    1.2.1 • Public • Published

    Plue Javascript SDK

    About

    This is the Javascript SDK for the Plue API.

    Installation

    via NPM:

    npm install @pluewallet/plue

    via CDN: https://cdn.jsdelivr.net/npm/@pluewallet/plue@{version_number}/build/plue.min.js

    or use the minified file in the build folder

    Getting started

    Client Side

    Initialize the SDK with:

    window.plue = new Plue(config);

    or

    const plue = new Plue(config);(NodeJS)

    Your config object should contain:

    • storageMethod - Options are session for sessionStorage and local for localStorage

    • apiVersion - Default is 3 (Version 3 is the only currently supported version)

    • apiToken - Your Plue API token

    Example:

        var config = {
            apiVersion: 3, 
            storageMethod: "local",
            apiToken: "authenticationTokenHere"
        }
    
    

    Server Side (NodeJS)

    Initialize the sdk with: const plue = new Plue(config);

    Your config object should contain:

    • apiVersion - Default is 3 (Version 3 is the only currently supported version)

    • apiToken - Your Plue API token

    Example:

        var config = {
            apiVersion: 3, 
            apiToken: "authenticationTokenHere"
        }
    
    

    Custom API url

    To use this SDK with a custom API url, your config object should contain customAPIURL

    Example:

        var config = {
            ...,
            customAPIURL: "https://whatever.stuff/
        }
    
    

    Documentation and usage

    For more detailed documentation and usage Docs.

    License

    MIT license.

    Keywords

    none

    Install

    npm i @pluewallet/plue

    DownloadsWeekly Downloads

    3

    Version

    1.2.1

    License

    MIT

    Unpacked Size

    425 kB

    Total Files

    12

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar