# tm-service-api

> Common tm microservice api methods

Latest version **2.0.4** (published 2017-09-21) · CC-BY-4.0 license · 0 weekly downloads

## Install

```sh
npm install tm-service-api
pnpm add tm-service-api
yarn add tm-service-api
bun add tm-service-api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.4 |
| Published | 2017-09-21 |
| First published | 2017-08-24 |
| Weekly downloads | 0 |
| License | CC-BY-4.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 11 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Anton Nemtsev |
| Maintainers | silentimp |
| Keywords | TM Micro Service, Template Monster, API |

## Links

- npm: https://www.npmjs.com/package/tm-service-api
- Repository: git@gitlab.com:TemplateMonster/PlasmaPlatform/Frontend/protoAPI
- npm.io page: https://npm.io/package/tm-service-api

## Dependencies (11)

- [husky](https://npm.io/package/husky.md) ^0.14.3
- [rimraf](https://npm.io/package/rimraf.md) ^2.6.1
- [babel-cli](https://npm.io/package/babel-cli.md) ^6.24.1
- [urlencode](https://npm.io/package/urlencode.md) ^1.1.0
- [babel-core](https://npm.io/package/babel-core.md) ^6.24.1
- [npm-run-all](https://npm.io/package/npm-run-all.md) ^4.1.1
- [babel-minify](https://npm.io/package/babel-minify.md) ^0.2.0
- [babel-polyfill](https://npm.io/package/babel-polyfill.md) ^6.26.0
- [babel-preset-env](https://npm.io/package/babel-preset-env.md) ^1.5.2
- [isomorphic-fetch](https://npm.io/package/isomorphic-fetch.md) ^2.2.1
- [babel-preset-stage-0](https://npm.io/package/babel-preset-stage-0.md) ^6.24.1

## Recent versions

- 2.0.4 (latest) — 2017-09-21
- 2.0.0 — 2017-09-20
- 1.0.18 — 2017-09-19
- 1.0.17 — 2017-09-19
- 1.0.16 — 2017-09-19
- 1.0.15 — 2017-09-13
- 1.0.14 — 2017-09-13
- 1.0.12 — 2017-08-31
- 1.0.11 — 2017-08-31
- 1.0.10 — 2017-08-31
- 1.0.9 — 2017-08-31
- 1.0.8 — 2017-08-31
- 1.0.7 — 2017-08-31
- 1.0.6 — 2017-08-31
- 1.0.5 — 2017-08-31
- … 5 more at https://npm.io/package/tm-service-api/versions

## README

# 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

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

## ErrorBadRequest

**Extends Error**

Custom error message for Bad Request server response

**Parameters**

-   `message` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | null)** error details (optional, default `null`)

### constructor

Constructor generates errorinstance

**Parameters**

-   `message` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | null)** error details (optional, default `null`)

Returns **[ErrorBadRequest](#errorbadrequest)** current instance

## ErrorNotFound

**Extends Error**

Custom error message for Not Found server response

**Parameters**

-   `message` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | null)** error details (optional, default `null`)

### constructor

Constructor generates error instance

**Parameters**

-   `message` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | null)** error details (optional, default `null`)

Returns **[ErrorNotFound](#errornotfound)** current instance

## ErrorServerResponse

**Extends Error**

Custom error message for abstract server response

**Parameters**

-   `statusCode` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** http status code
-   `statusText` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** http status code text
-   `message` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | null)** error details (optional, default `null`)

### constructor

Constructor generates error instance

**Parameters**

-   `statusCode` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** http status code
-   `statusText` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** http status code text
-   `message` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | null)** error details (optional, default `null`)

Returns **[ErrorServerResponse](#errorserverresponse)** current instance

## TMMicroServiceAPI

TM Micro Service Proto API

**Parameters**

-   `url` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** service url
-   `token` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | null)** user access tocken if available (optional, default `null`)

### url

Service URL

**Properties**

-   `service` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** url

### token

User access token

**Properties**

-   `token` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | null)?** user access tocken if available

### constructor

Constructor saves service url

**Parameters**

-   `url` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** service url
-   `token` **([string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String) | null)** user access tocken if available (optional, default `null`)
-   `version` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** service version (optional, default `'v1'`)

Returns **[TMMicroServiceAPI](#tmmicroserviceapi)** current instance

### messages

Object with class service messages

### setToken

Set access token

**Parameters**

-   `token` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** access token

### setVersion

Set service version

**Parameters**

-   `version` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** service version

### checkUrl

Validagte URL

**Parameters**

-   `url` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** service URL


-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** if URL do not match format Error will be thrown

Returns **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** url - service URL

### checkVersion

Validate service version

**Parameters**

-   `version` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** service version


-   Throws **[Error](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error)** if URL do not match format Error will be thrown

Returns **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** version - service version

### request

Fetch remote resource

**Parameters**

-   `url` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** resource url
-   `userOptions` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** user defined options

Returns **[Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)** Promise with server [Response](https://developer.mozilla.org/docs/Web/API/Response)

## tmpVersion

Service version

**Properties**

-   `version` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)?** service version

---
_Source: https://npm.io/package/tm-service-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
