@alicloud/tea-typescript

  • Version 1.8.0
  • Published
  • 48.7 kB
  • 2 dependencies
  • ISC license

Install

npm i @alicloud/tea-typescript
yarn add @alicloud/tea-typescript
pnpm add @alicloud/tea-typescript

Overview

[![NPM version][npm-image]][npm-url] [![build status][travis-image]][travis-url] [![codecov][cov-image]][cov-url] [![David deps][david-image]][david-url] [![npm download][download-image]][download-url]

Index

Functions

function allowRetry

allowRetry: (retry: TeaObject, retryTimes: number, startTime: number) => boolean;

    function cast

    cast: <T>(obj: any, t: T) => T;

      function doAction

      doAction: (request: Request, runtime?: TeaObject) => Promise<Response>;

        function getBackoffTime

        getBackoffTime: (backoff: TeaObject, retryTimes: number) => number;

          function isRetryable

          isRetryable: (err: Error) => boolean;

            function newError

            newError: (data: any) => ResponseError;

              function newUnretryableError

              newUnretryableError: (request: Request) => Error;

                function retryError

                retryError: (request: Request, response: Response) => Error;

                  function sleep

                  sleep: (ms: number) => Promise<void>;

                    function toMap

                    toMap: (value?: any) => any;

                      Classes

                      class BytesReadable

                      class BytesReadable extends Readable {}

                        constructor

                        constructor(value: any);

                          property value

                          value: Buffer;

                            class Model

                            class Model {}

                              constructor

                              constructor(map?: TeaObject);

                                method toMap

                                toMap: () => TeaObject;

                                  class Request

                                  class Request {}

                                    constructor

                                    constructor();

                                      property body

                                      body: Readable;

                                        property headers

                                        headers: TeaDict;

                                          property method

                                          method: string;

                                            property pathname

                                            pathname: string;

                                              property port

                                              port: number;

                                                property protocol

                                                protocol: string;

                                                  property query

                                                  query: TeaDict;

                                                    class Response

                                                    class Response {}

                                                      constructor

                                                      constructor(httpResponse: IncomingMessage);

                                                        property body

                                                        body: IncomingMessage;

                                                          property headers

                                                          headers: TeaDict;

                                                            property statusCode

                                                            statusCode: number;

                                                              property statusMessage

                                                              statusMessage: string;

                                                                method convertHeaders

                                                                convertHeaders: (headers: IncomingHttpHeaders) => TeaDict;

                                                                  method readBytes

                                                                  readBytes: () => Promise<Buffer>;

                                                                    Package Files (1)

                                                                    Dependencies (2)

                                                                    Dev Dependencies (7)

                                                                    Peer Dependencies (0)

                                                                    No peer dependencies.

                                                                    Badge

                                                                    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@alicloud/tea-typescript.

                                                                    • Markdown
                                                                      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@alicloud/tea-typescript)
                                                                    • HTML
                                                                      <a href="https://www.jsdocs.io/package/@alicloud/tea-typescript"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>