msg-interface - Msgpack Container Interface

 

$3

- MsgInterface is the interface for classes which support msgpack representation.

``typescript
interface MsgInterface {
msgpackLength: number;
writeMsgpackTo(buffer: Buffer, offset: number): number;
}
`

$3

- msgpackLength is maximum byte length possible for msgpack representation. It must be equal to or greater than the actual length.

$3

- writeMsgpackTo() writes msgpack representation to the BYO Buffer and returns the actual byte length written.

$3

- isMsg() returns true if the specified object implements the valid MsgInterface, otherwise false.

`typescript
declare function isMsg(msg: any): boolean;
`

$3

- msgToBuffer() returns a Buffer which contains msgpack representation.

`typescript
declare function msgToBuffer(msg: MsgInterface): Buffer;
``

$3

- https://github.com/kawanet/msg-interface

$3

- https://github.com/kawanet/msg-ext
- https://github.com/kawanet/msg-int64

$3

Copyright (c) 2017-2018 Yusuke Kawasaki

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.