Class Client

constructor

• new Client(
      clientFactory: ClientFactory,
      settings: ClientFactorySettings,
  ): Client

  Parameters

  • clientFactory: ClientFactory
  • settings: ClientFactorySettings

  Returns Client

Readonlyauth

Readonlystatus

addConnectionRestoredListener

• addConnectionRestoredListener(listener: () => void): void

  Parameters

  • listener: () => void

  Returns void

download

• download(
      streamDescriptor:
          | string
          | { filename?: string; type: string; [key: string]: unknown },
  ): void

  Starts a browser download of such a stream

  Parameters

  • streamDescriptor: string | { filename?: string; type: string; [key: string]: unknown }

  Returns void

followJob

• followJob(
      projectName: string,
      taskName: string,
      jobId: string,
      input?: Record<string, unknown>,
  ): Task

  Follows a job through the app's follow task (input job_uuid): a live task, it attaches again after a reconnect.

  Parameters

  • projectName: string
  • taskName: string
  • jobId: string
  • Optionalinput: Record<string, unknown>

  Returns Task

getDownloadUrl

• getDownloadUrl(
      streamDescriptor:
          | string
          | { filename?: string; type: string; [key: string]: unknown },
  ): string

  The URL that downloads a stream the server returned (a descriptor from a task's response, or a URL)

  Parameters

  • streamDescriptor: string | { filename?: string; type: string; [key: string]: unknown }

  Returns string

getServerInfo

• getServerInfo(): ServerInfo | null

  Returns ServerInfo | null

getTask

• getTask(id: string, name: string, nodeId?: string): Task

  Parameters

  • id: string
  • name: string
  • OptionalnodeId: string

  Returns Task

isExpired

• isExpired(auth: AuthToken): boolean

  Parameters

  • auth: AuthToken

  Returns boolean

onNodeChanged

• onNodeChanged(
      listener: (current: ServerInfo, previous: ServerInfo | null) => void,
  ): void

  When a reconnect lands on another node, or on a restarted one: tasks that ran there were lost (TASK_LOST_NODE_CHANGED).

  Parameters

  • listener: (current: ServerInfo, previous: ServerInfo | null) => void

  Returns void

post

• post(
      projectName: string,
      taskName: string,
      input?: unknown,
      auth?: AuthToken,
  ): Task

  Parameters

  • projectName: string
  • taskName: string
  • Optionalinput: unknown
  • Optionalauth: AuthToken

  Returns Task

• post(projectName: string, input?: unknown, auth?: AuthToken): Task

  Parameters

  • projectName: string
  • Optionalinput: unknown
  • Optionalauth: AuthToken

  Returns Task

• post(
      projectName: string,
      taskName: string,
      input?: unknown,
      auth?: AuthToken,
  ): Task

  Parameters

  • projectName: string
  • taskName: string
  • Optionalinput: unknown
  • Optionalauth: AuthToken

  Returns Task

setAuth

• setAuth(auth: AuthToken): Promise<void>

  Parameters

  • auth: AuthToken

  Returns Promise<void>

setDefaultErrorHandler

• setDefaultErrorHandler(
      defaultErrorHandler: {
          error(error: unknown, request: unknown, response: unknown): void;
      },
  ): void

  Where the error of a task without an error callback goes; the client calls its error(error, request, response)

  Parameters

  • defaultErrorHandler: { error(error: unknown, request: unknown, response: unknown): void }

  Returns void

validateAndSetAuth

• validateAndSetAuth(auth: AuthToken): Promise<void>

  Parameters

  • auth: AuthToken

  Returns Promise<void>