文档

TypeScript SDK使用手册

更新时间:

本文介绍了TypeScript SDK的安装方法、示例代码以及如何使用TypeScript SDK发布事件。

SDK简介

事件总线EventBridge的SDK分为管控API SDK和数据API SDK,示例代码有所不同。

  • 管控API SDK:对控制台页面进行操作使用的SDK。

  • 数据API SDK:事件数据的通道,目前只有发送事件(PutEvents)属于此类。

前提条件

您已完成以下操作:

环境准备

  1. 安装Node.js 8.0或以上的版本。更多信息,请参见安装Node.js

  2. 执行命令node -v查看Node.js版本。

  3. 执行以下命令全局安装TypeScript。

  4. npm install -g typescript

管控API SDK

安装SDK

执行以下命令安装TypeScript SDK。

npm install --save @alicloud/eventbridge20200401@1.0.1

SDK示例

您可以在OpenAPI门户通过调用API接口,自动生成对应的SDK示例。具体操作,请参见如何自动生成SDK示例

数据API SDK

安装SDK

  1. 执行以下命令安装TypeScript SDK。

    npm install @alicloud/eventbridge -S
  2. 执行以下命令安装打印端口。

    npm install @alicloud/tea-console -S

SDK示例

数据API SDK目前只包含发布事件(PutEvents),如需使用TypeScript SDK发布一个或多个事件,请参考以下示例代码。

import EventBridge, * as $EventBridge from '@alicloud/eventbridge';
import Util from '@alicloud/tea-util';
import Console from '@alicloud/tea-console';
import * as $tea from '@alicloud/tea-typescript';

export default class Client {

    /**
     * Create client初始化公共请求参数。
     */
    static async createClient(): Promise<EventBridge> {
        let config = new $EventBridge.Config({ });
        SetAccessKeyId(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_ID")).
        SetAccessKeySecret(os.Getenv("ALIBABA_CLOUD_ACCESS_KEY_SECRET")).
        SetEndpoint("<endpoint>")
        return new EventBridge(config);
    }

    /**
     * PutEvents
     */
    static async PutEvents(client: EventBridge): Promise<void> {
        let event = new $EventBridge.CloudEvent({ });
        event.datacontenttype = "application/json";
        event.data = Util.toBytes("test");
        event.id = "a5074581-7e74-4e4c-868f-47e7afdf8445";
        event.source = "acs.oss";
        event.specversion = "1.0";
        event.type = "oss:ObjectCreated:PostObject";
        event.time = "2020-08-24T13:54:05.965Asia/Shanghai";
        event.subject = "1.0";
        event.type = "acs:oss:cn-hangzhou:1234567:xls-papk/game_apk/123.jpg";
        event.extensions = {
            aliyuneventbusname: "demo-bus",
        };
        try {
            let resp = await client.putEvents([
                event
            ]);
            Console.log("--------------------Publish event to the aliyun EventBus--------------------");
            Console.log(Util.toJSONString($tea.toMap(resp)));
        } catch (error) {
            Console.log(error.message);
        }
    }

    static async main(args: string[]): Promise<void> {
        let client = await Client.createClient();
        await Client.PutEvents(client);
    }

}

Client.main(process.argv.slice(2));
  • 本页导读 (1)