cloudevents
/
sdk-javascript
mirror of https://github.com/cloudevents/sdk-javascript.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document the what and Parser API 

Signed-off-by: Fabio José <fabiojose@gmail.com>
This commit is contained in:
Fabio José 2019-06-10 21:25:26 -03:00
parent 8915048791
commit 7bf643491f
1 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -41,12 +41,14 @@ These are the supported specifications by this version.
### What we can do?
| **What** | **v0.1** | **v0.2** |
|---------------------------------------|----------|----------|
| Create events | yes | yes |
| Emit Structured events over HTTP | yes | yes |
| Emit Binary events over HTTP - | yes | yes |
| JSON Event Format | yes | yes |
| __What__ | __v0.1__ | __v0.2__ |
|------------------------------------|----------|----------|
| Create events | yes | yes |
| Emit Structured events over HTTP | yes | yes |
| Emit Binary events over HTTP | yes | yes |
| JSON Event Format | yes | yes |
| Receice Structure events over HTTP | yes | yes |
| Receice Binary events over HTTP | yes | yes |
## How to use
@ -262,13 +264,18 @@ String Formatter.toString(Object)
Every formatter class must implement these methods to work properly.
```js
/*
* The default constructor with Spec as parameter
*/
Parser(Spec)
/*
* Try to parse the payload to some event format
*/
Object Parser.parse(payload)
```
## `Spec` classes
### `Spec` classes
Every Spec class must implement these methods to work properly.