mappings Client - Stedi SDK for JavaScript

@stedi/sdk-client-mappings

Description

Stedi Mappings SDK for JavaScript.

Mappings lets you map JSON documents from one schema to another, using JSONata for its mapping expressions.

Installing

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

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

Getting Started

Initialize the client

First, create a new MappingsClient.

import { MappingsClient, CreateMappingCommand } from "@stedi/sdk-client-mappings";

const client = new MappingsClient({
  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 CreateMappingCommand.

import { MappingsClient, CreateMappingCommand } from "@stedi/sdk-client-mappings";

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

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

const command = new CreateMappingCommand(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;
   * }
   */
}