node package manager
Easy sharing. Manage teams and permissions with one click. Create a free org ยป

tm-service-api

TM Micro Service API Prototype class

This class provide fetch wrapper, token and Service URL setter mainly. Just to avoid code duplication.

Requirements

Possibly you will need babel-polyfill to use it.

Documentation

ErrorBadRequest

Extends Error

Custom error message for Bad Request server response

Parameters

  • message (string | null) error details (optional, default null)

constructor

Constructor generates errorinstance

Parameters

  • message (string | null) error details (optional, default null)

Returns ErrorBadRequest current instance

ErrorNotFound

Extends Error

Custom error message for Not Found server response

Parameters

  • message (string | null) error details (optional, default null)

constructor

Constructor generates error instance

Parameters

  • message (string | null) error details (optional, default null)

Returns ErrorNotFound current instance

ErrorServerResponse

Extends Error

Custom error message for abstract server response

Parameters

  • statusCode number http status code
  • statusText string http status code text
  • message (string | null) error details (optional, default null)

constructor

Constructor generates error instance

Parameters

  • statusCode number http status code
  • statusText string http status code text
  • message (string | null) error details (optional, default null)

Returns ErrorServerResponse current instance

TMMicroServiceAPI

TM Micro Service Proto API

Parameters

  • url string service url
  • token (string | null) user access tocken if available (optional, default null)

url

Service URL

Properties

token

User access token

Properties

  • token (string | null)? user access tocken if available

constructor

Constructor saves service url

Parameters

  • url string service url
  • token (string | null) user access tocken if available (optional, default null)
  • version string service version (optional, default 'v1')

Returns TMMicroServiceAPI current instance

messages

Object with class service messages

setToken

Set access token

Parameters

setVersion

Set service version

Parameters

  • version string service version

checkUrl

Validagte URL

Parameters

  • url string service URL

  • Throws Error if URL do not match format Error will be thrown

Returns string url - service URL

checkVersion

Validate service version

Parameters

  • version string service version

  • Throws Error if URL do not match format Error will be thrown

Returns string version - service version

request

Fetch remote resource

Parameters

  • url string resource url
  • userOptions Object user defined options

Returns Promise Promise with server Response

tmpVersion

Service version

Properties

  • version string? service version