Interface Options
interface Options {
allowArraysInMapKeys?: boolean;
bundleStrings?: boolean;
coercibleKeyAsNumber?: boolean;
copyBuffers?: boolean;
encodeUndefinedAsNil?: boolean;
int64AsNumber?: boolean;
int64AsType?: "string" | "number" | "bigint";
largeBigIntToFloat?: boolean;
largeBigIntToString?: boolean;
mapAsEmptyObject?: boolean;
mapsAsObjects?: boolean;
maxOwnStructures?: number;
maxSharedStructures?: number;
moreTypes?: boolean;
onInvalidDate?: () => any;
sequential?: boolean;
setAsEmptyObject?: boolean;
shouldShareStructure?: (keys: string[]) => boolean;
structuredClone?: boolean;
structures?: {}[];
useBigIntExtension?: boolean;
useFloat32?: FLOAT32_OPTIONS;
useRecords?: boolean | ((value: any) => boolean);
useTimestamp32?: boolean;
variableMapSize?: boolean;
writeFunction?: () => any;
getStructures?(): {}[];
saveStructures?(structures: {}[]): boolean | void;
}
allowArraysInMapKeys?: boolean;
bundleStrings?: boolean;
coercibleKeyAsNumber?: boolean;
copyBuffers?: boolean;
encodeUndefinedAsNil?: boolean;
int64AsNumber?: boolean;
int64AsType?: "string" | "number" | "bigint";
largeBigIntToFloat?: boolean;
largeBigIntToString?: boolean;
mapAsEmptyObject?: boolean;
mapsAsObjects?: boolean;
maxOwnStructures?: number;
maxSharedStructures?: number;
moreTypes?: boolean;
onInvalidDate?: () => any;
sequential?: boolean;
setAsEmptyObject?: boolean;
shouldShareStructure?: (keys: string[]) => boolean;
structuredClone?: boolean;
structures?: {}[];
useBigIntExtension?: boolean;
useFloat32?: FLOAT32_OPTIONS;
useRecords?: boolean | ((value: any) => boolean);
useTimestamp32?: boolean;
variableMapSize?: boolean;
writeFunction?: () => any;
getStructures?(): {}[];
saveStructures?(structures: {}[]): boolean | void;
}
Index
Methods
Properties
allowArraysInMapKeys?
bundleStrings?
coercibleKeyAsNumber?
copyBuffers?
encodeUndefinedAsNil?
int64AsNumber?
int64AsType?
largeBigIntToFloat?
largeBigIntToString?
mapAsEmptyObject?
mapsAsObjects?
maxOwnStructures?
maxSharedStructures?
moreTypes?
onInvalidDate?
sequential?
setAsEmptyObject?
shouldShareStructure?
structuredClone?
structures?
useBigIntExtension?
useFloat32?
useRecords?
useTimestamp32?
variableMapSize?
writeFunction?
Methods
OptionalgetStructures
Returns {}[]
OptionalsaveStructures
Parameters
- structures: {}[]
Returns boolean | void
Properties
OptionalallowArraysInMapKeys
allowArraysInMapKeys?: boolean
OptionalbundleStrings
bundleStrings?: boolean
OptionalcoercibleKeyAsNumber
coercibleKeyAsNumber?: boolean
OptionalcopyBuffers
copyBuffers?: boolean
OptionalencodeUndefinedAsNil
encodeUndefinedAsNil?: boolean
Optionalint64AsNumber
int64AsNumber?: boolean
Optionalint64AsType
int64AsType?: "string" | "number" | "bigint"
OptionallargeBigIntToFloat
largeBigIntToFloat?: boolean
OptionallargeBigIntToString
largeBigIntToString?: boolean
OptionalmapAsEmptyObject
mapAsEmptyObject?: boolean
OptionalmapsAsObjects
mapsAsObjects?: boolean
OptionalmaxOwnStructures
maxOwnStructures?: number
OptionalmaxSharedStructures
maxSharedStructures?: number
OptionalmoreTypes
moreTypes?: boolean
OptionalonInvalidDate
onInvalidDate?: () => any
Optionalsequential
sequential?: boolean
OptionalsetAsEmptyObject
setAsEmptyObject?: boolean
OptionalshouldShareStructure
shouldShareStructure?: (keys: string[]) => boolean
OptionalstructuredClone
structuredClone?: boolean
Optionalstructures
structures?: {}[]
OptionaluseBigIntExtension
useBigIntExtension?: boolean
OptionaluseFloat32
OptionaluseRecords
useRecords?: boolean | ((value: any) => boolean)
OptionaluseTimestamp32
useTimestamp32?: boolean
OptionalvariableMapSize
variableMapSize?: boolean
OptionalwriteFunction
writeFunction?: () => any
Deprecated
use int64AsType: 'number'