| 1 | # neon-js
|
| 2 |
|
| 3 | Constructed package using:
|
| 4 |
|
| 5 | - `neon-core`
|
| 6 | - `neon-api`
|
| 7 |
|
| 8 | In addition, this package exposes a high level semantic API binding for beginner usage. The semantic API can be found in the default export of the package.
|
| 9 |
|
| 10 | ```js
|
| 11 | const Neon = require("cityofzion/neon-js");
|
| 12 |
|
| 13 | console.log(Neon); // {wallet, tx, api, nep5, etc...}
|
| 14 |
|
| 15 | const NeonJs = neon.default;
|
| 16 |
|
| 17 | console.log(NeonJs); // {create, get, sign, verify,...}
|
| 18 | ```
|
| 19 |
|
| 20 | The semantic API follows a convention of Verb-Noun. Any extra words beyond the first 2 is collapsed into the Noun and camelcased.
|
| 21 |
|
| 22 | ```js
|
| 23 | NeonJs.create.stringStream("1234");
|
| 24 | NeonJs.encrypt.privateKey("key");
|
| 25 | ``` |
| \ | No newline at end of file |