tencentcloud-sdk-nodejs-commontest

  • Version 1.1.6
  • Published
  • 1.19 MB
  • 8 dependencies
  • Apache-2.0 license

Install

npm i tencentcloud-sdk-nodejs-commontest
yarn add tencentcloud-sdk-nodejs-commontest
pnpm add tencentcloud-sdk-nodejs-commontest

Overview

Tencent Cloud API NODEJS SDK

Index

Classes

class AbstractClient

class AbstractClient {}

constructor

constructor(
endpoint: string,
version: string,
{ credential, region, profile }: ClientConfig
);
  • 实例化client对象

    Parameter endpoint

    接入点域名

    Parameter version

    产品版本

    Parameter credential

    认证信息实例

    Parameter region

    产品地域

    Parameter profile

    可选配置实例

property apiVersion

apiVersion: string;

    property credential

    credential: Credential;

      property endpoint

      endpoint: string;

        property path

        path: string;

          property profile

          profile: ClientProfile;

            property region

            region: string;

              property sdkVersion

              sdkVersion: string;

                method request

                request: (
                action: string,
                req: any,
                options?: ResponseCallback | RequestOptions,
                cb?: ResponseCallback
                ) => Promise<ResponseData>;

                Interfaces

                interface ClientConfig

                interface ClientConfig {}
                • 初始化client对象参数类型

                property credential

                credential: Credential;
                • Parameter credential

                  认证信息 必选

                property profile

                profile?: ClientProfile;
                • Parameter profile

                  可选配置实例 可选,没有特殊需求可以跳过。

                property region

                region: string;
                • Parameter region

                  产品地域 必选

                interface ClientProfile

                interface ClientProfile {}
                • 可选配置实例

                property httpProfile

                httpProfile?: {
                /**
                * 请求方法
                * @type {"POST" | "GET"}
                * 非必选
                */
                reqMethod?: 'POST' | 'GET';
                /**
                * 接入点域名,形如(cvm.ap-shanghai.tencentcloud.com)
                * @type {string}
                * 非必选
                */
                endpoint?: string;
                /**
                * 协议,目前支持(https://)
                * @type {string}
                * 非必选
                */
                protocol?: string;
                /**
                * 请求超时时间,默认60s
                * @type {number}
                * 非必选
                */
                reqTimeout?: number;
                };
                • http相关选项实例 {httpProfile} 非必选

                property signMethod

                signMethod?: 'TC3-HMAC-SHA256' | 'HmacSHA256' | 'HmacSHA1';
                • 签名方法 (TC3-HMAC-SHA256 HmacSHA1 HmacSHA256) {string} 非必选

                interface Credential

                interface Credential {}
                • 认证信息类

                property secretId

                secretId?: string;
                • 腾讯云账户secretId,secretKey 非必选,和 token 二选一

                property secretKey

                secretKey?: string;
                • 腾讯云账户secretKey 非必选,和 token 二选一

                property token

                token?: string;
                • 腾讯云账户token 非必选,和 secretId 二选一

                Namespaces

                namespace get-stream

                module 'get-stream' {}

                  namespace is-stream

                  module 'is-stream' {}

                    Package Files (4)

                    Dependencies (8)

                    Dev Dependencies (10)

                    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/tencentcloud-sdk-nodejs-commontest.

                    • Markdown
                      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/tencentcloud-sdk-nodejs-commontest)
                    • HTML
                      <a href="https://www.jsdocs.io/package/tencentcloud-sdk-nodejs-commontest"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>