@stedi/sdk-client-queues
TypeScript icon, indicating that this package has built-in type declarations

0.4.78 • Public • Published

@stedi/sdk-client-queues

NPM version NPM downloads Stability Index Minimum Node.js version

Description

Stedi Queues SDK for JavaScript.

Installing

To install the this package, simply type add or install @stedi/sdk-client-queues using your favorite package manager:

  • npm install @stedi/sdk-client-queues
  • yarn add @stedi/sdk-client-queues
  • pnpm add @stedi/sdk-client-queues

Getting Started

Initialize the client

First, create a new QueuesClient.

import { QueuesClient, ChangeMessageVisibilityCommand } from "@stedi/sdk-client-queues";

const client = new QueuesClient({
  region: "us",
  apiKey: "my-api-key",
});

Usage

Once the client is initiated, you may use it to send multiple commands. If you are using a custom http handler, you may call destroy() to close open connections.

Create a command by creating a new ChangeMessageVisibilityCommand.

import { QueuesClient, ChangeMessageVisibilityCommand } from "@stedi/sdk-client-queues";

const client = new QueuesClient({
  region: "us",
  apiKey: "my-api-key",
});

const params = {
  /** input parameters */
};

const command = new ChangeMessageVisibilityCommand(params);

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  // error handling.
} finally {
  // finally.
}

Troubleshooting

When the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).

try {
  const data = await client.send(command);
  // process data.
} catch (error) {
  const { requestId, cfId, extendedRequestId } = error.$metadata;
  console.log({ requestId, cfId, extendedRequestId });
  /**
   * The keys within exceptions are also parsed.
   * You can access them by checking if it is a certain instance of exception:
   * if (error instanceof SomeServiceException) {
   *     const value = error.specialKeyInException;
   * }
   */
}

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

Client Commands (Operations List)

ChangeMessageVisibility

Command API Reference / Input / Output

ChangeMessageVisibilityBatch

Command API Reference / Input / Output

CreateQueue

Command API Reference / Input / Output

DeleteMessage

Command API Reference / Input / Output

DeleteMessageBatch

Command API Reference / Input / Output

DeleteQueue

Command API Reference / Input / Output

DescribeQueue

Command API Reference / Input / Output

GetQueueAttributes

Command API Reference / Input / Output

ListQueues

Command API Reference / Input / Output

PurgeQueue

Command API Reference / Input / Output

ReceiveMessage

Command API Reference / Input / Output

SendMessage

Command API Reference / Input / Output

SendMessageBatch

Command API Reference / Input / Output

UpdateQueue

Command API Reference / Input / Output

Versions

Current Tags

VersionDownloads (Last 7 Days)Tag
0.4.785latest

Version History

VersionDownloads (Last 7 Days)Published
0.4.785
0.4.772
0.4.760
0.4.750
0.4.740
0.4.730
0.4.720
0.4.7111
0.4.700
0.4.690
0.4.680
0.4.670
0.4.660
0.4.650
0.4.640
0.4.630
0.4.61122
0.4.600
0.4.590
0.4.580
0.4.570
0.4.560
0.4.551
0.4.540
0.4.530
0.4.520
0.4.510
0.4.500
0.4.490
0.4.480
0.4.470
0.4.460
0.4.450
0.4.440
0.4.430
0.4.420
0.4.410
0.4.400
0.4.390
0.4.380
0.4.370
0.4.360
0.4.350
0.4.340
0.4.330
0.4.320
0.4.310
0.4.300
0.4.290
0.4.280
0.4.270
0.4.260
0.4.250
0.4.240
0.4.230
0.4.220
0.4.210
0.4.200
0.4.190
0.4.180
0.4.170
0.4.160
0.4.150
0.4.140
0.4.130
0.4.120
0.4.110
0.4.100
0.4.90
0.4.80
0.4.70
0.4.60
0.4.50
0.4.40
0.4.30
0.4.20
0.4.10
0.4.00
0.3.50
0.3.40
0.3.30
0.3.20
0.3.10
0.3.00
0.2.370
0.2.360
0.2.350
0.2.340
0.2.330
0.2.310
0.2.300
0.2.290
0.2.280
0.2.270
0.2.260
0.2.250
0.2.240
0.2.230
0.2.220
0.2.210
0.2.200
0.2.190
0.2.180
0.2.170
0.2.160
0.2.150
0.2.140
0.2.130
0.2.110
0.2.100
0.2.90
0.2.80
0.2.70
0.2.60
0.2.50
0.2.40
0.2.30
0.2.20
0.2.10
0.2.00
0.1.530
0.1.521,250
0.1.510
0.1.500
0.1.490
0.1.480
0.1.470
0.1.460
0.1.450
0.1.440
0.1.431
0.1.421
0.1.410
0.1.400
0.1.390
0.1.380
0.1.370
0.1.360
0.1.350
0.1.340
0.1.330
0.1.320
0.1.310
0.1.300
0.1.290
0.1.280
0.1.270
0.1.260
0.1.250
0.1.240
0.1.230
0.1.220
0.1.210

Package Sidebar

Install

npm i @stedi/sdk-client-queues

Weekly Downloads

1,393

Version

0.4.78

License

Apache-2.0

Unpacked Size

879 kB

Total Files

406

Last publish

Collaborators

  • stediengineering