@plasma-platform/service-api

Full documentation
install:
npm i @plasma-platform/service-api -S

Short documentation

Table of Contents

• TMMicroServiceAPI
  • Parameters
• url
  • Properties
• token
  • Properties
• timeOut
  • Properties
• timeOutObjects
  • Properties
• messages
• setUrl
  • Parameters
• setToken
  • Parameters
• setTimeOut
  • Parameters
• setVersion
  • Parameters
• checkVersion
  • Parameters
• request
  • Parameters
• tmpVersion
  • Properties
• ErrorNotFound
  • Parameters
• ErrorServerResponse
  • Parameters
• ErrorBadRequest
  • Parameters

TMMicroServiceAPI

TM Micro Service Proto API

Parameters

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

url

Service URL

Properties

• service string url

token

User access token

Properties

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

timeOut

timeOut for request

Properties

• timeOut (number | boolean)? time for timeout request

timeOutObjects

timeOutObjects container for timeouts

Properties

• timeOut object? container for timeouts

messages

Object with class service messages

Type: Object

setUrl

Set url

Parameters

• url string

setToken

Set access token

Parameters

• token string access token

setTimeOut

Set timeOut

Parameters

• milliseconds integer milliseconds time

setVersion

Set service version

Parameters

• version string service version

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

ErrorNotFound

Custom error message for Not Found server response

Parameters

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

ErrorServerResponse

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)

ErrorBadRequest

Custom error message for Bad Request server response

Parameters

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