docs(README): Update readme to mention that CloudEvents are read-only now (#248)

* also update readme with a mention about the cloneWith method

Signed-off-by: Lucas Holmquist <lholmqui@redhat.com>
This commit is contained in:
Lucas Holmquist 2020-07-15 09:50:46 -04:00 committed by GitHub
parent 13bcdb4b98
commit de6f0a2945
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 0 deletions

View File

@ -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