@xylabs/api

Base functionality used throughout XY Labs TypeScript/JavaScript libraries

Reference

@xylabs/api

Classes

• ApiClient
• ApiEndpoint

Interfaces

• ApiConfig

Type Aliases

• ApiStage

Variables

• ApiStage

Functions

• getApiStage

classes

ApiClient

@xylabs/api

Constructors

Constructor

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

Parameters

token?

null | string

stage?

ApiStage

Returns

ApiClient

Properties

token?

protected optional token: null | string;

stage?

protected optional stage: ApiStage;

Methods

endPoint()

abstract endPoint(): string;

Returns

string

ApiEndpoint

@xylabs/api

Type Parameters

T

T

Constructors

Constructor

new ApiEndpoint<T>(config, path): ApiEndpoint<T>;

Parameters

config

ApiConfig

path

string

Returns

ApiEndpoint<T>

Accessors

value

Get Signature

get value(): undefined | T;

Returns

undefined | T

Methods

fetch()

fetch(): Promise<T>;

Returns

Promise<T>

get()

get(): Promise<T | NonNullable<T>>;

Returns

Promise<T | NonNullable<T>>

insert()

insert(value): Promise<T>;

Parameters

value

T

Returns

Promise<T>

functions

getApiStage

@xylabs/api

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

Parameters

hostname

string

Returns

"beta" | "local" | "prod"

interfaces

ApiConfig

@xylabs/api

Properties

apiDomain

apiDomain: string;

apiKey?

optional apiKey: string;

jwtToken?

optional jwtToken: string;

userid?

optional userid: string;

type-aliases

ApiStage

@xylabs/api

type ApiStage = EnumValue<typeof ApiStage>;

variables

ApiStage

@xylabs/api

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