@aws-sdk/smithy-client

What is @aws-sdk/smithy-client?

@aws-sdk/smithy-client is a foundational package used in the AWS SDK for JavaScript. It provides the core client and command abstractions that are used to build service clients for AWS services. This package is part of the modular AWS SDK for JavaScript (v3), which allows developers to import only the specific AWS services they need.

What are @aws-sdk/smithy-client's main functionalities?

Client Creation

This feature allows you to create a custom client by extending the base Client class provided by the @aws-sdk/smithy-client package. This is useful for creating service-specific clients.

const { Client } = require('@aws-sdk/smithy-client');

class MyServiceClient extends Client {
  constructor(config) {
    super(config);
  }
}

const client = new MyServiceClient({ region: 'us-west-2' });

Command Creation

This feature allows you to create custom commands by extending the base Command class. Commands encapsulate the input and middleware logic for making API calls.

const { Command } = require('@aws-sdk/smithy-client');

class MyCommand extends Command {
  constructor(input) {
    super();
    this.input = input;
  }

  resolveMiddleware(clientStack, configuration, options) {
    // Middleware logic here
  }
}

const command = new MyCommand({ key: 'value' });

Middleware Stack

This feature allows you to create and manage a stack of middleware functions that can be used to modify the behavior of commands and clients. Middleware can be added at various stages of the request lifecycle.

const { MiddlewareStack } = require('@aws-sdk/smithy-client');

const stack = new MiddlewareStack();
stack.add((next, context) => async (args) => {
  console.log('Before request');
  const result = await next(args);
  console.log('After request');
  return result;
}, {
  step: 'initialize',
  name: 'loggingMiddleware',
});

Other packages similar to @aws-sdk/smithy-client

axios

Axios is a popular HTTP client for making requests to APIs. While it does not provide the same level of abstraction for AWS services, it is often used for general-purpose HTTP requests and can be extended with custom middleware.

request

Request is another HTTP client library for Node.js. It is similar to axios in that it is used for making HTTP requests, but it has a more extensive set of features for handling different types of requests and responses.

superagent

Superagent is a small, progressive HTTP request library for Node.js and browsers. It is similar to axios and request but is known for its simplicity and ease of use.

README

@aws-sdk/smithy-client

An internal package

Usage

You probably shouldn't, at least directly.

Changelog

3.23.0 (2021-07-23)

Bug Fixes

• client-sts: duplicate stripInternal entry in tsconfig (#2545) (e7bcbbc)
• clients: allow undefined configuration (#2617) (a004d15)
• smithy-client: export type explicitly (#2598) (e643735), closes #2597
• bump up tslib to 2.3.0 (#2601) (7040faa)

Features

• clients: change runtime config from constant to provider functions (#2574) (5eca565)