Document the binding usage
Signed-off-by: Fabio José <fabiojose@gmail.com>
This commit is contained in:
parent
20c3296c55
commit
ceb5c4531a
34
README.md
34
README.md
|
@ -94,6 +94,11 @@ Every Spec class must implement these methods to work properly.
|
||||||
|
|
||||||
```js
|
```js
|
||||||
|
|
||||||
|
/*
|
||||||
|
* The constructor must receives the Cloudevent type.
|
||||||
|
*/
|
||||||
|
Spec(Cloudevent)
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Check the spec constraints, throwing an error if do not pass.
|
* Check the spec constraints, throwing an error if do not pass.
|
||||||
*/
|
*/
|
||||||
|
@ -168,6 +173,35 @@ var formatted = cloudevent.format();
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Hot to emit the event?
|
||||||
|
|
||||||
|
```js
|
||||||
|
// The event
|
||||||
|
var cloudevent = new Cloudevent()
|
||||||
|
.type("com.github.pull.create")
|
||||||
|
.source("urn:event:from:myapi/resourse/123");
|
||||||
|
|
||||||
|
// The binding configuration using POST
|
||||||
|
var config = {
|
||||||
|
method: 'POST',
|
||||||
|
url : 'https://mywebhook.com'
|
||||||
|
};
|
||||||
|
|
||||||
|
// The binding instance
|
||||||
|
var binding = Cloudevent.bindings['http-structured0.1'](config);
|
||||||
|
|
||||||
|
// Emit the event using Promise
|
||||||
|
binding.emit(cloudevent)
|
||||||
|
.then(response => {
|
||||||
|
// Treat the response
|
||||||
|
console.log(response.data);
|
||||||
|
|
||||||
|
}).catch(err => {
|
||||||
|
// Treat the error
|
||||||
|
console.error(err);
|
||||||
|
});
|
||||||
|
```
|
||||||
|
|
||||||
> See how to implement the method injection [here](lib/specs/spec_0_1.js#L17)
|
> See how to implement the method injection [here](lib/specs/spec_0_1.js#L17)
|
||||||
>
|
>
|
||||||
> Learn about [Builder Design Pattern](https://en.wikipedia.org/wiki/Builder_pattern)
|
> Learn about [Builder Design Pattern](https://en.wikipedia.org/wiki/Builder_pattern)
|
||||||
|
|
Loading…
Reference in New Issue