Skip to content

README.md

Latest commit

 

History

History
90 lines (66 loc) · 5.78 KB

README.md

File metadata and controls

90 lines (66 loc) · 5.78 KB

Queue

Overview

Background job queue

Available Operations

queueEnqueue

Add job to queue

Example Usage

import { SDK } from "@aerostack/sdk-node";

const sdk = new SDK({
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await sdk.queue.queueEnqueue({
    type: "send-email",
    data: {
      "key": "<value>",
    },
    delay: 60,
  });

  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { SDKCore } from "@aerostack/sdk-node/core.js";
import { queueQueueEnqueue } from "@aerostack/sdk-node/funcs/queueQueueEnqueue.js";

// Use `SDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const sdk = new SDKCore({
  apiKeyAuth: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const res = await queueQueueEnqueue(sdk, {
    type: "send-email",
    data: {
      "key": "<value>",
    },
    delay: 60,
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("queueQueueEnqueue failed:", res.error);
  }
}

run();

Parameters

Parameter Type Required Description
request operations.QueueEnqueueRequestBody ✔️ The request object to use for the request.
options RequestOptions ➖ Used to set various options for making HTTP requests.
options.fetchOptions RequestInit ➖ Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries RetryConfig ➖ Enables retrying HTTP requests under certain failure conditions.

Response

Promise<operations.QueueEnqueueResponseBody>

Errors

Error Type Status Code Content Type
errors.SDKError 4XX, 5XX */*