TSBufferOptions interface

Signature:

export interface TSBufferOptions

Properties

Property	Type	Description
cloneProto?	boolean	(Optional) Clone the proto, don't change this if you don't know what it is.
customTypes?	{ [schemaId: string]: CustomTypeSchema; }	(Optional) Append `CustomTypeSchema` to given schema, to customize validate & encode methods for specific types. For example 'mongodb/ObjectId'.
excessPropertyChecks	boolean	检查值中是否包含Schema定义之外多余的字段仅对 `validate` 方法生效是因为实现机制原因, `prune` `encode` `decode` 方法都会天然保证不会混入多余字段默认：`true`
skipDecodeValidate	boolean	正常解码流程是：先进行二进制解码，再校验解码后的类型符合Schema定义此值为 `true` 时，将跳过校验步骤以提升性能但需要自行确保值类型合法，否则可能引发不确定的问题默认为 `false`
skipEncodeValidate	boolean	正常编码流程是：先校验value类型合法，再进行编码此值为 `true` 时，将跳过校验步骤以提升性能但需要自行确保值类型合法，否则可能引发不确定的问题默认为 `false`
strictNullChecks	boolean	同 `tsconfig.json` 中的 `strictNullChecks` 是否使用严格等于去判定 `undefined` 和 `null` 如果该值为 `false`，则在编码过程中，`null` 在类型不兼容时可编码为`undefined`，解码过程中，`undefined` 在类型不兼容时可解码为 `null`。