Nearly Pure Mustard

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

    0.0.35 • Public • Published

    @stedi/sdk-client-sftp

    NPM version NPM downloads

    Description

    Stedi SDK for JavaScript that includes Sftp Client for Node.js, Browser and React Native.

    Stedi SFTP provides a fully managed, serverless SFTP infrastructure. You can use the SFTP API to manage SFTP users. For accessing files, you should use the Stedi Buckets SDK.

    Installing

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

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

    Getting Started

    Import

    The Stedi SDK is modulized by clients and commands. To send a request, you only need to import the SftpClient and the commands you need, for example CreateUserCommand:

    // ES5 example
    const { SftpClient, CreateUserCommand } = require("@stedi/sdk-client-sftp");
    // ES6+ example
    import { SftpClient, CreateUserCommand } from "@stedi/sdk-client-sftp";

    Usage

    To send a request, you:

    • Initiate client with configuration (e.g. credentials, region).
    • Initiate command with input parameters.
    • Call send operation on client with command object as input.
    • If you are using a custom http handler, you may call destroy() to close open connections.
    // a client can be shared by different commands.
    const client = new SftpClient({ region: "REGION" });
    
    const params = {
      /** input parameters */
    };
    const command = new CreateUserCommand(params);

    Async/await

    We recommend using await operator to wait for the promise returned by send operation as follows:

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

    Async-await is clean, concise, intuitive, easy to debug and has better error handling as compared to using Promise chains or callbacks.

    Promises

    You can also use Promise chaining to execute send operation.

    client.send(command).then(
      (data) => {
        // process data.
      },
      (error) => {
        // error handling.
      }
    );

    Promises can also be called using .catch() and .finally() as follows:

    client
      .send(command)
      .then((data) => {
        // process data.
      })
      .catch((error) => {
        // error handling.
      })
      .finally(() => {
        // finally.
      });

    Callbacks

    We do not recommend using callbacks because of callback hell, but they are supported by the send operation.

    // callbacks.
    client.send(command, (err, data) => {
      // process err and data.
    });

    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.

    Keywords

    none

    Install

    npm i @stedi/sdk-client-sftp

    DownloadsWeekly Downloads

    1,995

    Version

    0.0.35

    License

    Apache-2.0

    Unpacked Size

    251 kB

    Total Files

    141

    Last publish

    Collaborators

    • stediengineering