67 lines
1.9 KiB
TypeScript
67 lines
1.9 KiB
TypeScript
import { Token } from './lib/token'
|
|
|
|
export type TokenOrNestedTokens = Token | Token[] | TokenOrNestedTokens[]
|
|
|
|
export interface Reference {
|
|
parent: Reference | undefined
|
|
obj: object | any[]
|
|
includes(obj: object | any[]): boolean
|
|
}
|
|
|
|
export type OptionalTypeEncoder = (data: any, typ: string, options: EncodeOptions, refStack?: Reference) => TokenOrNestedTokens | null
|
|
|
|
export type StrictTypeEncoder = (data: any, typ: string, options: EncodeOptions, refStack?: Reference) => TokenOrNestedTokens
|
|
|
|
export type TokenTypeEncoder = {
|
|
(writer: ByteWriter, token: Token, options?: EncodeOptions): void;
|
|
compareTokens(t1: Token, t2: Token): number;
|
|
// TODO: make this non-optional as a breaking change and remove the throw in length.js
|
|
encodedSize?(token: Token, options?: EncodeOptions): number;
|
|
}
|
|
|
|
export type MapSorter = (e1: (Token | Token[])[], e2: (Token | Token[])[]) => number
|
|
|
|
export type QuickEncodeToken = (token: Token) => Uint8Array | undefined
|
|
|
|
export interface DecodeTokenizer {
|
|
done(): boolean,
|
|
next(): Token,
|
|
pos(): number,
|
|
}
|
|
|
|
export type TagDecoder = (inner: any) => any
|
|
|
|
export interface DecodeOptions {
|
|
allowIndefinite?: boolean
|
|
allowUndefined?: boolean
|
|
coerceUndefinedToNull?: boolean
|
|
allowInfinity?: boolean
|
|
allowNaN?: boolean
|
|
allowBigInt?: boolean
|
|
strict?: boolean
|
|
useMaps?: boolean
|
|
rejectDuplicateMapKeys?: boolean
|
|
retainStringBytes?: boolean
|
|
tags?: TagDecoder[],
|
|
tokenizer?: DecodeTokenizer
|
|
}
|
|
|
|
export interface EncodeOptions {
|
|
float64?: boolean,
|
|
addBreakTokens?: boolean,
|
|
mapSorter?: MapSorter,
|
|
quickEncodeToken?: QuickEncodeToken,
|
|
typeEncoders?: { [typeName: string]: OptionalTypeEncoder }
|
|
/**
|
|
* If true, plain object properties with `undefined` values are ignored during
|
|
* encoding.
|
|
*/
|
|
ignoreUndefinedProperties?: boolean,
|
|
}
|
|
|
|
export interface ByteWriter {
|
|
chunks: (Uint8Array | number[])[];
|
|
reset(): void;
|
|
push(bytes: Uint8Array | number[]): void;
|
|
toBytes(reset?: boolean | undefined): Uint8Array;
|
|
}
|