Skip to content

Update readme that mentions CloudEvents are read-only now #248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 15, 2020
Merged

Update readme that mentions CloudEvents are read-only now #248

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f2aafa7
chore(README): update readme with a mention about CloudEvents being r…
lholmquist Jul 14, 2020
c84fbae
squash: nits
lholmquist Jul 15, 2020
82279f8
squash: address nits
lholmquist Jul 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,22 @@ emitter.send(new CloudEvent({ specversion: Version.V03, source, type }))
}).catch(console.error);
```

## CloudEvent Objects

All created `CloudEvent` objects are read-only. If you need to update a property or add a new extension to an existing cloud event object, you can use the `cloneWith` method. This will return a new `CloudEvent` with any update or new properties. For example:

```js
const {
CloudEvent,
} = require("cloudevents-sdk");

// Create a new CloudEvent
const ce = new CloudEvent({...});

// Add a new extension to an existing CloudEvent
const ce2 = ce.cloneWith({extension: "Value"});
```

### Example Applications

There are a few trivial example applications in
Expand Down