@microsoft/signalr-protocol-msgpack
Version:
MsgPack Protocol support for ASP.NET Core SignalR
59 lines (58 loc) • 1.59 kB
TypeScript
/**
* MessagePack Options per:
* {@link https://github.com/msgpack/msgpack-javascript#api msgpack-javascript Options}
*/
export interface MessagePackOptions {
/**
* @name extensionCodec encoding, decoding extensions: default ExtensionCodec.defaultCodec
*/
extensionCodec?: any;
/**
* @name context user-defined context
*/
context?: any;
/**
* @name maxDepth maximum object depth for encoding
*/
maxDepth?: number;
/**
* @name initialBufferSize starting encode buffer size
*/
initialBufferSize?: number;
/**
* @name sortKeys Force a determinate key order for encoding
*/
sortKeys?: boolean;
/**
* @name forceFloat32 Force floats to be encoded as 32-bit floats
*/
forceFloat32?: boolean;
/**
* @name forceIntegerToFloat Force integers to be encoded as floats
*/
forceIntegerToFloat?: boolean;
/**
* @name ignoreUndefined ignore undefined values when encoding
*/
ignoreUndefined?: boolean;
/**
* @name maxStrLength maximum string decoding length
*/
maxStrLength?: number;
/**
* @name maxBinLength maximum binary decoding length
*/
maxBinLength?: number;
/**
* @name maxArrayLength maximum array decoding length
*/
maxArrayLength?: number;
/**
* @name maxMapLength maximum map decoding length
*/
maxMapLength?: number;
/**
* @name maxExtLength maximum decoding length
*/
maxExtLength?: number;
}