@xylabs/api

[![logo][]](https://xylabs.com)

[![main-build][]][main-build-link]
[![npm-badge][]][npm-link]
[![npm-downloads-badge][]][npm-link]
[![jsdelivr-badge][]][jsdelivr-link]
[![npm-license-badge][]](LICENSE)
[![codacy-badge][]][codacy-link]
[![codeclimate-badge][]][codeclimate-link]
[![snyk-badge][]][snyk-link]
[![socket-badge][]][socket-link]

Base functionality used throughout XY Labs TypeScript/JavaScript libraries

Reference

@xylabs/api

*

Classes

- ApiClient
- ApiEndpoint

Interfaces

- ApiConfig

Type Aliases

- ApiStage

Variables

- ApiStage

Functions

- getApiStage

$3

### ApiClient

@xylabs/api

*

Constructors

$3

``ts
new ApiClient(token?, stage?): ApiClient;
`

$3

#### token?

null | string

#### stage?

ApiStage

$3

ApiClient

Properties

$3

`ts
protected optional token: null | string;
`

*

$3

`ts
protected optional stage: ApiStage;
`

Methods

$3

`ts
abstract endPoint(): string;
`

$3

string

### ApiEndpoint

@xylabs/api

*

Type Parameters

$3

T

Constructors

$3

`ts
new ApiEndpoint(config, path): ApiEndpoint;
`

$3

#### config

ApiConfig

#### path

string

$3

ApiEndpoint\<T\>

Accessors

$3

$3

`ts
get value(): undefined | T;
`

#### Returns

undefined \| T

Methods

$3

`ts
fetch(): Promise;
`

$3

Promise\<T\>

*

$3

`ts
get(): Promise>;
`

$3

Promise\<T \| NonNullable\<T\>\>

*

$3

`ts
insert(value): Promise;
`

$3

#### value

T

$3

Promise\<T\>

$3

### getApiStage

@xylabs/api

*

`ts
function getApiStage(hostname): "beta" | "local" | "prod";
`

Parameters

$3

string

Returns

"beta" \| "local" \| "prod"

$3

### ApiConfig

@xylabs/api

*

Properties

$3

`ts
apiDomain: string;
`

*

$3

`ts
optional apiKey: string;
`

*

$3

`ts
optional jwtToken: string;
`

*

$3

`ts
optional userid: string;
`

$3

### ApiStage

@xylabs/api

*

`ts
type ApiStage = EnumValue;
`

$3

### ApiStage

@xylabs/api

*

`ts
const ApiStage: Enum<{
Beta: "beta";
Local: "local";
Prod: "prod";
}>;
``

Part of sdk-js

Maintainers

- Arie Trouw (arietrouw.com)
- Matt Jones
- Joel Carter
- Jordan Trouw

License

> See the LICENSE file for license details

Credits

Made with 🔥 and ❄️ by XYLabs

[logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg

[main-build]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml/badge.svg
[main-build-link]: https://github.com/xylabs/sdk-js/actions/workflows/build.yml
[npm-badge]: https://img.shields.io/npm/v/@xylabs/api.svg
[npm-link]: https://www.npmjs.com/package/@xylabs/api
[codacy-badge]: https://app.codacy.com/project/badge/Grade/c8e15e14f37741c18cfb47ac7245c698
[codacy-link]: https://www.codacy.com/gh/xylabs/sdk-js/dashboard?utm_source=github.com&utm_medium=referral&utm_content=xylabs/sdk-js&utm_campaign=Badge_Grade
[codeclimate-badge]: https://api.codeclimate.com/v1/badges/c5eb068f806f0b047ea7/maintainability
[codeclimate-link]: https://codeclimate.com/github/xylabs/sdk-js/maintainability
[snyk-badge]: https://snyk.io/test/github/xylabs/sdk-js/badge.svg?targetFile=package.json
[snyk-link]: https://snyk.io/test/github/xylabs/sdk-js?targetFile=package.json

[npm-downloads-badge]: https://img.shields.io/npm/dw/@xylabs/api
[npm-license-badge]: https://img.shields.io/npm/l/@xylabs/api

[jsdelivr-badge]: https://data.jsdelivr.com/v1/package/npm/@xylabs/api/badge
[jsdelivr-link]: https://www.jsdelivr.com/package/npm/@xylabs/api

[socket-badge]: https://socket.dev/api/badge/npm/package/@xylabs/api
[socket-link]: https://socket.dev/npm/package/@xylabs/api