All files / json-pack/src/msgpack index.ts

100% Statements 21/21
100% Branches 0/0
40% Functions 4/10
100% Lines 11/11

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44                                                            11x 15x 11x 11x 11x 16x 11x 22x 17x     11x 11x  
/**
 * # `json-pack` MessagePack`
 *
 * Library for encoding and decoding JavaScript native structures to MessagePack
 * format.
 *
 * Use `Encoder` to encode plain JSON values.
 *
 * ```ts
 * import {Encoder, Decoder} from 'json-pack/lib/json-pack';
 *
 * const encoder = new Encoder();
 * const decoder = new Decoder();
 * const buffer = encoder.encode({foo: 'bar'});
 * const obj = decoder.decode(buffer);
 *
 * console.log(obj); // { foo: 'bar' }
 * ```
 *
 * For more:
 *
 * - Use {@link Encoder} to encode only JSON values.
 * - Use {@link EncoderFull} to also encode binary data, extensions and pre-computed MessagePack buffers.
 * - To encode binary data use `Uint8Array`.
 * - To encode an extension use {@link JsonPackExtension}.
 * - To encode a pre-computed MessagePack value use {@link JsonPackValue}.
 *
 * @module
 */
 
export * from './types';
export {MsgPackEncoderFast} from './MsgPackEncoderFast';
export {MsgPackEncoder} from './MsgPackEncoder';
export {MsgPackEncoderStable} from './MsgPackEncoderStable';
export {MsgPackDecoder} from './MsgPackDecoder';
export {MsgPackDecoderFast} from './MsgPackDecoderFast';
export {MsgPackToJsonConverter} from './MsgPackToJsonConverter';
export {JsonPackValue} from '../JsonPackValue';
export {JsonPackExtension} from '../JsonPackExtension';
 
// User-friendly aliases
export {MsgPackEncoder as MessagePackEncoder} from './MsgPackEncoder';
export {MsgPackDecoder as MessagePackDecoder} from './MsgPackDecoder';