JavaScript/TypeScript SDK for CloudEvents

Go to file

Fabio José 104b74acf5 Documentation Signed-off-by: Fabio José <fabiojose@gmail.com>		2018-11-09 16:09:18 -02:00
lib	Refactoring for formats directory	2018-11-09 16:09:18 -02:00
test	First impl.	2018-11-09 16:09:17 -02:00
.gitignore	Repository init	2018-11-08 15:54:22 -02:00
LICENSE	Initial commit	2018-09-20 15:54:57 -04:00
README.md	Documentation	2018-11-09 16:09:18 -02:00
index.js	First impl.	2018-11-09 16:09:17 -02:00
package.json	First impl.	2018-11-09 16:09:17 -02:00

README.md

sdk-javascript

Javascript SDK for CloudEvents

Repository Structure

├── index.js
├── lib
│   ├── cloudevent.js
│   ├── jsonformatter.js
│   ├── format
│   │   └── json_0_1.js
│   └── specs
│       ├── spec_0_1.js
│       └── spec_0_2.js
├── LICENSE
├── package.json
├── README.md
└── test
    ├── cloudevent_spec_0_1.js
    └── cloudevent_spec_0_2.js

index.js: library exports
lib/cloudevent.js: implementation of Cloudevent, an interface
lib/format/: every format implementation goes here
lib/format/json_0_1.js: implementation for JSON formatting version 0.1
lib/specs/: every spec implementation goes here
lib/specs/spec_0_1.js: implementation for spec version 0.1
lib/specs/spec_0_2.js: implementation for spec version 0.2
test/cloudevent_spec_0_1.js: unit testing for spec 0.1
test/cloudevent_spec_0_2.js: unit testing for spec 0.2

How to use


/* 
 * Constructs a default instance with:
 *   - Spec 0.1
 *   - JSON Format 0.1
 */
var cloudevent01 = new Cloudevent();

/*
 * Constructs an instance with:
 *   - Spec 0.2
 *   - JSON Format 0.1 
 */
var cloudevent02 = new Cloudevent(Cloudevent.specs['0.2']);