@lfewallet/lfe v1.0.1

Lfe Javascript SDK

About

This is the Javascript SDK for the Lfe API.

Installation

via NPM:

npm install @lfewallet/lfe

via CDN:

https://cdn.jsdelivr.net/npm/@lfewallet/lfe@{version_number}/build/lfe.min.js

or use the minified file in the build folder

Getting started

Client Side

Initialize the SDK with:

window.lfe = new Lfe(config);

or

const lfe = new Lfe(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 Lfe API token

Example:

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

Server Side (NodeJS)

Initialize the sdk with: const lfe = new Lfe(config);

Your config object should contain:

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

• apiToken - Your Lfe 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.