415gotit

node_modules/@msgpack/msgpack/dist.esm/Decoder.d.ts

@@ -0,0 +1,136 @@
+import type { ContextOf } from "./context.ts";
+import type { ExtensionCodecType } from "./ExtensionCodec.ts";
+import type { KeyDecoder } from "./CachedKeyDecoder.ts";
+export type DecoderOptions<ContextType = undefined> = Readonly<Partial<{
+    extensionCodec: ExtensionCodecType<ContextType>;
+    /**
+     * Decodes Int64 and Uint64 as bigint if it's set to true.
+     * Depends on ES2020's {@link DataView#getBigInt64} and
+     * {@link DataView#getBigUint64}.
+     *
+     * Defaults to false.
+     */
+    useBigInt64: boolean;
+    /**
+     * By default, string values will be decoded as UTF-8 strings. However, if this option is true,
+     * string values will be returned as Uint8Arrays without additional decoding.
+     *
+     * This is useful if the strings may contain invalid UTF-8 sequences.
+     *
+     * Note that this option only applies to string values, not map keys. Additionally, when
+     * enabled, raw string length is limited by the maxBinLength option.
+     */
+    rawStrings: boolean;
+    /**
+     * Maximum string length.
+     *
+     * Defaults to 4_294_967_295 (UINT32_MAX).
+     */
+    maxStrLength: number;
+    /**
+     * Maximum binary length.
+     *
+     * Defaults to 4_294_967_295 (UINT32_MAX).
+     */
+    maxBinLength: number;
+    /**
+     * Maximum array length.
+     *
+     * Defaults to 4_294_967_295 (UINT32_MAX).
+     */
+    maxArrayLength: number;
+    /**
+     * Maximum map length.
+     *
+     * Defaults to 4_294_967_295 (UINT32_MAX).
+     */
+    maxMapLength: number;
+    /**
+     * Maximum extension length.
+     *
+     * Defaults to 4_294_967_295 (UINT32_MAX).
+     */
+    maxExtLength: number;
+    /**
+     * An object key decoder. Defaults to the shared instance of {@link CachedKeyDecoder}.
+     * `null` is a special value to disable the use of the key decoder at all.
+     */
+    keyDecoder: KeyDecoder | null;
+    /**
+     * A function to convert decoded map key to a valid JS key type.
+     *
+     * Defaults to a function that throws an error if the key is not a string or a number.
+     */
+    mapKeyConverter: (key: unknown) => MapKeyType;
+}>> & ContextOf<ContextType>;
+type MapKeyType = string | number;
+export declare class Decoder<ContextType = undefined> {
+    private readonly extensionCodec;
+    private readonly context;
+    private readonly useBigInt64;
+    private readonly rawStrings;
+    private readonly maxStrLength;
+    private readonly maxBinLength;
+    private readonly maxArrayLength;
+    private readonly maxMapLength;
+    private readonly maxExtLength;
+    private readonly keyDecoder;
+    private readonly mapKeyConverter;
+    private totalPos;
+    private pos;
+    private view;
+    private bytes;
+    private headByte;
+    private readonly stack;
+    private entered;
+    constructor(options?: DecoderOptions<ContextType>);
+    private clone;
+    private reinitializeState;
+    private setBuffer;
+    private appendBuffer;
+    private hasRemaining;
+    private createExtraByteError;
+    /**
+     * @throws {@link DecodeError}
+     * @throws {@link RangeError}
+     */
+    decode(buffer: ArrayLike<number> | ArrayBufferView | ArrayBufferLike): unknown;
+    decodeMulti(buffer: ArrayLike<number> | ArrayBufferView | ArrayBufferLike): Generator<unknown, void, unknown>;
+    decodeAsync(stream: AsyncIterable<ArrayLike<number> | ArrayBufferView | ArrayBufferLike>): Promise<unknown>;
+    decodeArrayStream(stream: AsyncIterable<ArrayLike<number> | ArrayBufferView | ArrayBufferLike>): AsyncGenerator<unknown, void, unknown>;
+    decodeStream(stream: AsyncIterable<ArrayLike<number> | ArrayBufferView | ArrayBufferLike>): AsyncGenerator<unknown, void, unknown>;
+    private decodeMultiAsync;
+    private doDecodeSync;
+    private readHeadByte;
+    private complete;
+    private readArraySize;
+    private pushMapState;
+    private pushArrayState;
+    private decodeString;
+    /**
+     * @throws {@link RangeError}
+     */
+    private decodeUtf8String;
+    private stateIsMapKey;
+    /**
+     * @throws {@link RangeError}
+     */
+    private decodeBinary;
+    private decodeExtension;
+    private lookU8;
+    private lookU16;
+    private lookU32;
+    private readU8;
+    private readI8;
+    private readU16;
+    private readI16;
+    private readU32;
+    private readI32;
+    private readU64;
+    private readI64;
+    private readU64AsBigInt;
+    private readI64AsBigInt;
+    private readF32;
+    private readF64;
+}
+export {};