Class Client

constructor

• new Client(
      __namedParameters: {
          authBearer?: string;
          base: URL;
          defs?: HNamespace;
          fetch?: FetchMethod;
          getHaystackServiceUrl?: getHaystackServiceUrlCallback;
          getHostServiceUrl?: getHostServiceUrlCallback;
          getOpUrl?: getOpUrlCallback;
          getServiceUrl?: getServiceUrlCallback;
          options?: RequestInit;
          pathPrefix?: string;
          project?: string;
      },
  ): Client

• Constructs a new client.

  Parameters

  • __namedParameters: {
        authBearer?: string;
        base: URL;
        defs?: HNamespace;
        fetch?: FetchMethod;
        getHaystackServiceUrl?: getHaystackServiceUrlCallback;
        getHostServiceUrl?: getHostServiceUrlCallback;
        getOpUrl?: getOpUrlCallback;
        getServiceUrl?: getServiceUrlCallback;
        options?: RequestInit;
        pathPrefix?: string;
        project?: string;
    }

  Returns Client

defs

Readonlyext

Readonlyfetch

Readonlyfunctions

Readonlygroups

Readonlynotifications

ReadonlynotificationsSettings

Readonlyops

Readonlyorigin

ReadonlypathPrefix

Readonlyproj

Readonlyproject

Readonlyrecord

Readonlyroles

Readonlyschedule

Readonlyuser

Readonlywatch

close

• close(): Promise<void>

• Closes the client.

  Warning: this will close any watches associated with this client. Any watches may throw an error if they are used after being closed.

  Returns Promise<void>

fetchVal

• fetchVal<T extends HVal>(
      resource: RequestInfo,
      body?: HVal | HaysonVal,
      options?: RequestInit,
  ): Promise<T>

• Fetch a haystack value from the server.

  Type Parameters

  • T extends HVal

  Parameters

  • resource: RequestInfo

    The resource to request.
  • Optionalbody: HVal | HaysonVal

    Optional haystack value used for the request's body.
  • Optionaloptions: RequestInit

    Optional object containing any custom settings.

  Returns Promise<T>

  A promise that resolves to a value.

  Throws

  A fetch or grid error.

getDefaultOptions

• getDefaultOptions(): RequestInit

• Returns RequestInit

  The default options to used with a fetch operation.

getHaystackServiceUrl

• getHaystackServiceUrl(service: string): string

• Returns the URL for a haystack service.

  Parameters

  • service: string

  Returns string

  A URL.

getHostServiceUrl

• getHostServiceUrl(path: string): string

• Returns the URL for a host service.

  Parameters

  • path: string

    The path of the service.

  Returns string

  A URL.

getOpUrl

• getOpUrl(op: string): string

• Returns the URL for an op.

  Parameters

  • op: string

    The op to create the URL for.

  Returns string

  A URL.

getServiceUrl

• getServiceUrl(path: string): string

• Returns the origin API Url

  Parameters

  • path: string

    Name of the API

  Returns string

  A URL.

isDefsLoaded

• isDefsLoaded(): boolean

• Returns boolean

  True if the defs have been loaded using this service.

loadDefs

• loadDefs(): Promise<void>

• Asynchronously load the defs library using this service.

  Please note, this will overwrite any existing defs loaded.

  Returns Promise<void>

  A promise that's resolved once the defs have been loaded.

toJSON

• toJSON(): {
      haystackServiceUrl: string;
      hostServiceUrl: string;
      opUrl: string;
      pathPrefix: string;
      project: string;
  }

• Returns {
      haystackServiceUrl: string;
      hostServiceUrl: string;
      opUrl: string;
      pathPrefix: string;
      project: string;
  }

  A JSON object of the Client that uniquely identifies it.