@plade/sdk

Plade Javascript sdk

Installation

yarn add @plade/sdk

Usage

To get started, instantiate a new Plade client with your store credentials.

Note: This may require a Plade account.

// JavaScript
import { gateway as PladeGateway } from '@plade/sdk'

const Plade = PladeGateway({
  clientId: 'XXX'
})

// Node.js
const PladeGateway = require('@plade/sdk').gateway

const Plade = PladeGateway({
  clientId: 'XXX',
  clientSecret: 'XXX'
})

Note: If you're using webpack, you'll need to add the following to your projects configuration file.

{
"node": {
      "fs": "empty"
    }
}

Custom Storage

By default the Plade SDK persists data to window.localStorage in the browser and node-localstorage in Node. If this doesn't suit your needs you can override the default storage with a MemoryStorageFactory which will persist data for the life cycle of the JavaScript VM:

import { gateway as PladeGateway, MemoryStorageFactory } from '@plade/sdk'

const Plade = PladeGateway({
  clientId: 'XXX',
  storage: new MemoryStorageFactory()
});

Or alternatively, create your own storage factory by passing in an object which implements the following interface:

interface StorageFactory {
  set(key: string, value: string): void;
  get(key: string): string | null;
  delete(key: string): void;
}