@types/ungap__structured-clone/index.d.ts

TypeScript definitions for @ungap/structured-clone

export as namespace structuredClone;

/**
 * Returns a clone of the input value.
 * @param any a serializable value.
 * @param options an object with a `lossy` property that,
 *  if `true`, will not throw errors on incompatible types, and behave more
 *  like JSON stringify would behave. Symbol and Function will be discarded.
 * @returns a clone of the input value
 */
declare function structuredClone<T>(any: T, options?: { json?: boolean; lossy?: boolean }): T;
export = structuredClone;

declare namespace structuredClone {
    type SerializedRecordIndex = [number, any] | SerializedRecordIndex[];
    type SerializedRecord = [SerializedRecordIndex[], ...Array<[number, any]>];

    /**
     * Serialize the input.
     * @param serializable a serializable value.
     * @param options an object with a `lossy` property that,
     *  if `true`, will not throw errors on incompatible types, and behave more
     *  like JSON stringify would behave. Symbol and Function will be discarded.
     * @returns an array of SerializedRecord
     */
    function serialize(serializable: any, options?: { json?: boolean; lossy?: boolean }): SerializedRecord;

    /**
     * Deserialize the output.
     * @param serialized a previously serialized value.
     * @returns Deserialized output
     */
    function deserialize(serialized: SerializedRecord): any;
}