From c603831e934c68c1f430708b5bff4dad938093dd Mon Sep 17 00:00:00 2001 From: David Pereira Date: Wed, 26 Jan 2022 21:54:49 +0000 Subject: [PATCH] docs: add TS examples for CloudEvent usage (#461) * docs: add TS examples for CloudEvent usage Co-authored-by: Lance Ball --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index debc785..b3b7d81 100644 --- a/README.md +++ b/README.md @@ -132,6 +132,29 @@ const ce = new CloudEvent({...}); const ce2 = ce.cloneWith({extension: "Value"}); ``` +You can create a `CloudEvent` object in many ways, for example, in TypeScript: + +```js +import { CloudEvent, CloudEventV1, CloudEventV1Attributes } from "cloudevents"; +const ce: CloudEventV1 = { + specversion: '1.0', + source: '/some/source', + type: 'example', + id: '1234' +}; +const event = new CloudEvent(ce); +const ce2: CloudEventV1Attributes = { + specversion: '1.0', + source: '/some/source', + type: 'example', +}; +const event2 = new CloudEvent(ce2); +const event3 = new CloudEvent({ + source: '/some/source', + type: 'example', +}); +``` + ### Example Applications There are a few trivial example applications in