diff options
Diffstat (limited to 'node_modules/capnp-ts/README.md')
| -rw-r--r-- | node_modules/capnp-ts/README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/node_modules/capnp-ts/README.md b/node_modules/capnp-ts/README.md new file mode 100644 index 0000000..a5c6723 --- /dev/null +++ b/node_modules/capnp-ts/README.md @@ -0,0 +1,21 @@ +# capnp-ts + +A strongly typed [Cap'n Proto](https://capnproto.org/) implementation for the browser and Node.js using TypeScript. + +Here's a quick usage example: + +```typescript +import * as capnp from 'capnp-ts'; + +import {MyStruct} from './myschema.capnp'; + +export function loadMessage(buffer: ArrayBuffer): MyStruct { + + const message = capnp.Message.fromArrayBuffer(buffer); + + return message.getRoot(MyStruct); + +} +``` + +An extended readme is available on the project site: [https://github.com/jdiaz5513/capnp-ts](https://github.com/jdiaz5513/capnp-ts). |
