@envizage/services v0.4.0

Envizage Services

A list of Javascript methods and an HTTP client implementation that can be used to interact with the Envizage API. Type definitions are included.

Table of contents

1. Pre-requisites
2. Installation
3. Usage
   1. HTTP Client

1. Pre-requisites

The @envizage/model package is a peer dependency for this project. Make sure that a version equal to or newer than the minimum required in the package.json file is installed. You can install the @envizage/model package using the following command:"

$ npm install --save @envizage/model # Or alternatively: `yarn add @envizage/model`

2. Installation

The SDK package can be installed as a usual npm package:

$ npm install --save @envizage/services # Or alternatively: `yarn add @envizage/services`

3. Usage

1. The HTTP Client

An HTTP Client implementation is required as a dependency for all services included in this SDK. The HTTP client that will be injected has to implement the IHttpClient interface:

export interface IHttpClient {
  get: <T>(url: string, params?: Map<string, string>, headerMap?: string[][]) => Promise<T>,

  post: <T, U>(url: string, body: T, params?: Map<string, string>, headerMap?: string[][]) => Promise<U>,

  put: <T, U>(url: string, body: T, params?: Map<string, string>, headerMap?: string[][]) => Promise<U>,

  remove: <T>(url: string, params?: Map<string, string>, headerMap?: string[][]) => Promise<T>
}

A user of the SDK can either implement that interface or import a ready fetch-based implementation that comes with the SDK:

  import { HttpClient } from "@envizage/services";

2. Envizage API service implementations