Class Api

constructor

• new Api(origin: string, options?: ApiOptions): Api

  Connect to Datalynk & send requests

  Parameters

  • origin: string

    API URL
  • options: ApiOptions = {}

  Returns Api

  Example

  const api = new Api('https://spoke.auxiliumgroup.com');
  Copy

Readonlyauth

Optionaldatabase

Readonlyfiles

Readonlygps

online$

options

Readonlyorigin

Readonlypdf

Readonlypwa

sliceCache

Readonlysocket

status$

Readonlysuperuser

token$

url

version

Readonlywebrtc

Staticversion

expired

• get expired(): boolean

  Is token expired

  Returns boolean

jwtPayload

• get jwtPayload(): null | JwtPayload

  Get session info from JWT payload

  Returns null | JwtPayload

offline

• get offline(): boolean

  Whether normal Datalynk API access is currently unavailable.

  This is the inverse of online. It can be true while the browser still has Internet access, for example during MySQL/HTTP 5xx recovery.

  Returns boolean

online

• get online(): null | boolean

  Whether normal Datalynk network requests are currently available.

  This becomes false for network outages, rejected/expired sessions, and request-owned server recovery. It therefore describes Datalynk availability rather than only navigator.onLine.

  Returns null | boolean
• set online(value: null | boolean): void

  Override the boolean connection state.

  Set true or false to force the corresponding state. Set null to remove the override and resume normal connection checking. This is a manual override and can supersede the current recovery state, so normal applications should generally observe status instead of forcing it.

  Parameters

  • value: null | boolean

  Returns void

reauthenticationPending

• get reauthenticationPending(): boolean

  Whether authentication expired while offline and must be renewed before replaying queued work.

  Returns boolean

spoke

• get spoke(): string

  Logged in spoke

  Returns string

status

• get status(): ApiConnectionStatus

  Current detailed Datalynk API connection state.

  Returns ApiConnectionStatus

token

• get token(): null | string

  Returns null | string

• set token(token: null | string): void

  Parameters

  • token: null | string

  Returns void

chain

• chain(...requests: any[]): Promise<any>

  Chain multiple requests to execute together

  Parameters

  • ...requests: any[]

    List of requests to chain

  Returns Promise<any>

  API Response

chainMap

• chainMap(request: { [key: string]: any }): Promise<any>

  Organize multiple requests into a single mapped request

  Parameters

  • request: { [key: string]: any }

    Map of requests

  Returns Promise<any>

  Map of API Responses

chat

• chat(): Promise<Chat>

  Lazily load and construct chat. No chat code or requests run before this call.

  Returns Promise<Chat>

debug

• debug<T = any>(data: any, options?: ApiRequestOptions): Promise<T>

  Exact same as the request method, but logs the response in the console automatically

  Type Parameters

  • T = any

  Parameters

  • data: any

    Datalynk request as object or string
  • Optionaloptions: ApiRequestOptions

  Returns Promise<T>

  Datalynk response
• debug<T = any>(
      data: any,
      options: { offline: true } & ApiRequestOptions,
  ): Promise<void | T>

  Exact same as the request method, but logs the response in the console automatically

  Type Parameters

  • T = any

  Parameters

  • data: any

    Datalynk request as object or string
  • options: { offline: true } & ApiRequestOptions

  Returns Promise<void | T>

  Datalynk response

getSlices

• getSlices(): Promise<number[]>

  Get list of slices

  Returns Promise<number[]>

openChat

• openChat(options?: ChatGuiOptions): Promise<ChatWindow>

  Lazily load, authorize, and open the reusable chat window.

  Parameters

  • options: ChatGuiOptions = {}

  Returns Promise<ChatWindow>

request

• request<T = any>(data: any, options?: ApiRequestOptions): Promise<T>

  Send a request to Datalynk

  Type Parameters

  • T = any

  Parameters

  • data: any

    Request using Datalynk API syntax. Strings will be converted: '$/auth/current' -> {'$/auth/current': {}}
  • Optionaloptions: ApiRequestOptions

  Returns Promise<T>

  Datalynk response or error

  Example

  const response = await api.request('$/auth/current');
  Copy

• request<T = any>(
      data: any,
      options: { offline: true } & ApiRequestOptions,
  ): Promise<void | T>

  Send a request to Datalynk

  Type Parameters

  • T = any

  Parameters

  • data: any

    Request using Datalynk API syntax. Strings will be converted: '$/auth/current' -> {'$/auth/current': {}}
  • options: { offline: true } & ApiRequestOptions

  Returns Promise<void | T>

  Datalynk response or error

  Example

  const response = await api.request('$/auth/current');
  Copy

slice

• slice<T extends Meta = any>(id: string | number): Slice<T>

  Create a slice object using the API

  Type Parameters

  • T extends Meta = any

  Parameters

  • id: string | number

    Slice ID the object will target

  Returns Slice<T>

  Object for making requests & caching rows

  Example

  const contactsSlice = api.slice<Contacts>(12345);
  const allContacts = await contactsSlice.select().exec().rows();
  const unsubscribe = contactsSlice.sync().subscribe(rows => console.log(rows));
  Copy