createHttpTaskQueue

Purpose and behavior

Return a TaskQueue client that sends each operation to a serveTaskQueue() server with a bearer token, fixed or resolved before every request. A refused request rejects with Queue request rejected (<status>) and redirects are not followed. The client holds no connection to close.

Complete example and detailed rules.

Parameters and properties

• optionsRequired
  QueueClientOptions
  Server URL, bearer token and per-request timeout.
• options.urlRequired
  string
  Base URL of a serveTaskQueue() server, http or https, without credentials, query or fragment; requests go to <url>/queue.
• options.tokenRequired
  string | (() => string | Promise<string>)
  Bearer token, or a function called before every request, lease renewals and completions included, so a rotated token applies at once. Each value must be 32 to 512 non-whitespace characters.
• options.timeoutMsOptional
  number | undefined
  Time limit per HTTP request in milliseconds, default 10000, counted after the token is resolved.

Returns

TaskQueue

Signature

export declare function createHttpTaskQueue(
  options: QueueClientOptions,
): TaskQueue;

Related contracts

• QueueClientOptions
• TaskQueue