Installation

With NPM

npm install @fleetbase/sdk

With Yarn

yarn add @fleetbase/sdk

Documentation

See the documentation webpage.

If you would like to make contributions to the Fleetbase Javascript SDK documentation source, here is a guide in doing so.

Quick Start for Browser

import Fleetbase from '@fleetbase/sdk';

const fleetbase = new Fleetbase('Your Public Key');

// create a place
const speceNeedle = await fleetbase.places.create({
    name: 'Space Needle',
    street1: '400 Broad Street',
    city: 'Seattle',
    state: 'WA',
    country: 'US',
});

Quick Start for Node

import Fleetbase from '@fleetbase/sdk';

const fleetbase = new Fleetbase('Your Secret Key');

// create a place
const speceNeedle = await fleetbase.places.create({
    name: 'Space Needle',
    street1: '400 Broad Street',
    city: 'Seattle',
    state: 'WA',
    country: 'US',
});

Create a custom adapter

You're able to create a custom adapter to handle network request in the Fleetbase SDK. The Fleetbase SDK ships with two standard adapters. The BrowserAdapter which is based on fetch() and the NodeAdapter based on axios.

import { Adapter } from '@fleetbase/sdk';

class CustomAdapter extends Adapter {
    constructor(config) {
        super(config);
    }

    get() {}
    post() {}
    put() {}
    patch() {}
    delete() {}
}