snapshot-fs/dist/esm/read.d.ts

Create a filesystem snapshot for use with memfs

import { type CborUint8Array } from '@jsonjoy.com/json-pack/lib/cbor/index.js';
import { type JsonUint8Array, type SnapshotNode } from 'memfs/lib/snapshot/index.js';
import { type CreateSnapshotOptions, type FsApi } from './snapshot.js';
/**
 * Options for {@link readSnapshot}
 */
export type ReadSnapshotOptions = CreateSnapshotOptions;
/**
 * Get the type of snapshot data for a given snapshot kind
 * @template K Snapshot kind
 */
export type SnapshotForKind<K extends SnapshotKind> = K extends typeof CBOR_KIND ? CborUint8Array<SnapshotNode> : K extends typeof CJSON_KIND ? JsonUint8Array<SnapshotNode> : K extends typeof JSON_KIND ? string | Uint8Array : never;
/**
 * Three (3) types of "snapshots" are supported:
 * - `cbor`: A CBOR-encoded snapshot
 * - `cjson`: A "compact" JSON-encoded snapshot
 * - `json`: A DirectoryJSON snapshot-ish data structure (lossy)
 */
export type SnapshotKind = typeof CBOR_KIND | typeof CJSON_KIND | typeof JSON_KIND;
/**
 * CBOR snapshot kind
 */
export declare const CBOR_KIND = "cbor";
/**
 * Compact JSON snapshot kind
 */
export declare const CJSON_KIND = "cjson";
/**
 * {@link DirectoryJSON} snapshot kind
 */
export declare const JSON_KIND = "json";
/**
 * Reads a CBOR-encoded snapshot and populates a virtual file system.
 *
 * @param data - The CBOR-encoded data representing the snapshot.
 * @param options - Options for reading the snapshot.
 * @param options.fs - The file system to populate. Defaults to an in-memory file system.
 * @param options.separator - The path separator to use.
 * @param options.source - The root path of the source.
 * @returns A promise that resolves to the populated file system API.
 */
export declare function readCBORSnapshot(data: CborUint8Array<SnapshotNode>, { fs, separator, source: root }?: ReadSnapshotOptions): Promise<FsApi>;
/**
 * Reads a CJSON snapshot and populates a filesystem with its contents.
 *
 * @param data - The JSON data representing the snapshot.
 * @param options - Options for reading the snapshot.
 * @param options.fs - The filesystem to populate. Defaults to an in-memory filesystem.
 * @param options.separator - The path separator to use.
 * @param options.source - The root path for the filesystem.
 * @returns A promise that resolves to the populated filesystem API.
 */
export declare function readCJSONSnapshot(data: JsonUint8Array<SnapshotNode>, { fs, separator, source: root }?: ReadSnapshotOptions): Promise<FsApi>;
/**
 * Reads a directory JSON snapshot and populates a filesystem with its contents.
 *
 * @param data - The JSON data representing the directory structure. Can be a string or Uint8Array.
 * @param options - Options for reading the snapshot.
 * @param options.fs - The filesystem to populate. If not provided, a new in-memory filesystem will be created.
 * @param options.separator - The path separator to use.
 * @param options.source - The root path for the source filesystem.
 *
 * @returns A promise that resolves to the populated filesystem.
 *
 * @throws Will throw an error if the JSON data is invalid.
 */
export declare function readDirectoryJSONSnapshot(data: string | Uint8Array, { fs, separator, source: root }?: ReadSnapshotOptions): Promise<FsApi>;
/**
 * Reads a snapshot into a new virtual filesystem or existing filesystem
 *
 * @param data Raw snapshot data in `DirectoryJSON`, CSJON or CBOR format
 * @param options Options
 * @returns The value of `options.fs` populated with the snapshot contents, or a new `memfs` `Volume`.
 */
export declare function readSnapshot<K extends SnapshotKind, T extends SnapshotForKind<K>>(kind: K, data: T, options?: ReadSnapshotOptions): Promise<FsApi>;
//# sourceMappingURL=read.d.ts.map