@stedi/sdk-client-guides


Description

Stedi Guides SDK for JavaScript.

Installing

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

- npm install @stedi/sdk-client-guides
- yarn add @stedi/sdk-client-guides
- pnpm add @stedi/sdk-client-guides

Getting Started

$3

First, create a new GuidesClient.

``ts
import { GuidesClient, ChangeGuideNetworkSettingsCommand } from "@stedi/sdk-client-guides";

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

$3

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 ChangeGuideNetworkSettingsCommand.

`ts
import { GuidesClient, ChangeGuideNetworkSettingsCommand } from "@stedi/sdk-client-guides";

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

const params = {
/* input parameters /
};

const command = new ChangeGuideNetworkSettingsCommand(params);

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

$3

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

`js
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)