@tai-kun/surrealdb
Version:
The SurrealDB SDK for JavaScript
53 lines • 2.44 kB
TypeScript
import type { Uint8ArrayLike } from "@tai-kun/surrealdb/types";
import { type MajorType } from "./spec";
import type { Writer } from "./writer";
/**
* [API Reference](https://tai-kun.github.io/surrealdb.js/v2/api/cbor/others/#writeheader)
*/
export declare function writeHeader(w: Writer, mt: MajorType, length: number | bigint): void;
/**
* [API Reference](https://tai-kun.github.io/surrealdb.js/v2/api/cbor/others/#writepayload)
*/
export declare function writePayload(w: Writer, value: Uint8ArrayLike): void;
/**
* [API Reference](https://tai-kun.github.io/surrealdb.js/v2/api/cbor/others/#writebytestring)
*/
export declare function writeByteString(w: Writer, value: Uint8ArrayLike): void;
/**
* [API Reference](https://tai-kun.github.io/surrealdb.js/v2/api/cbor/others/#writeutf8string)
*/
export declare function writeUtf8String(w: Writer, value: string): void;
/**
* [API Reference](https://tai-kun.github.io/surrealdb.js/v2/api/cbor/others/#writeencodedutf8string)
*/
export declare function writeEncodedUtf8String(w: Writer, value: Uint8ArrayLike): void;
/**
* [API Reference](https://tai-kun.github.io/surrealdb.js/v2/api/cbor/others/#writenullable)
*/
export declare function writeNullable(w: Writer, value: null | undefined): void;
/**
* [API Reference](https://tai-kun.github.io/surrealdb.js/v2/api/cbor/others/#writeboolean)
*/
export declare function writeBoolean(w: Writer, value: boolean): void;
/**
* [API Reference](https://tai-kun.github.io/surrealdb.js/v2/api/cbor/others/#writenumber)
*/
export declare function writeNumber(w: Writer, value: number): void;
export declare function writeBigInt(w: Writer, value: bigint): void;
declare const CONTINUE: unique symbol;
export type Replacer = (value: symbol | object) => unknown | typeof CONTINUE;
export type IsSafeMapKey = (key: unknown, map: ReadonlyMap<unknown, unknown>) => boolean;
export type IsSafeObjectKey = (key: string | number, obj: {
readonly [p: string]: unknown;
}) => boolean;
export interface WriteOptions {
readonly isSafeMapKey?: IsSafeMapKey | undefined;
readonly isSafeObjectKey?: IsSafeObjectKey | undefined;
readonly replacer?: Replacer | readonly Replacer[] | undefined;
}
/**
* [API Reference](https://tai-kun.github.io/surrealdb.js/v2/api/cbor/others/#write)
*/
export declare function write(w: Writer, value: unknown, options?: WriteOptions | undefined): void;
export {};
//# sourceMappingURL=write-utils.d.ts.map