fs-extender
Version:
Extras suite for node fs module
59 lines (58 loc) • 2.54 kB
TypeScript
/// <reference types="node" />
import * as fs from "../patch";
import * as util from "../util";
import * as NodeFs from "fs";
/** Options for ensureDir and ensureDirSync */
export declare type EnsureOptionsDir = {
/** Mode defined for directory, default is 777 */
mode?: fs.Mode;
};
export declare type _EnsureOptionsDirInternal = Required<EnsureOptionsDir>;
/** Options for stream creation when stream is true */
export declare type EnsureOptionsFileStreamOptions = {
flags?: string | undefined;
encoding?: BufferEncoding | undefined;
fd?: number | NodeFs.promises.FileHandle | undefined;
mode?: number | undefined;
autoClose?: boolean | undefined;
/**
* @default false
*/
emitClose?: boolean | undefined;
start?: number | undefined;
highWaterMark?: number | undefined;
};
/** Options for ensureFile and ensureFileSync */
export declare type EnsureOptionsFile = EnsureOptionsDir & {
/** Data to be written in the file */
data?: string | NodeJS.ArrayBufferView;
/** Encoding to be used when data is string*/
encoding?: BufferEncoding | null | undefined;
/** Mode defined for the directory where file will be created */
dirMode?: fs.Mode;
/** File to be created must return a stream to the user, default is false */
stream?: boolean;
/** Options for the stream creation when stream is true */
streamOptions?: BufferEncoding | EnsureOptionsFileStreamOptions;
flag?: string;
};
export declare type _EnsureOptionsFileInternal = Omit<EnsureOptionsFile, "flag" | "stream"> & Required<Pick<EnsureOptionsFile, "flag" | "stream">>;
/** options for ensureSymlink and ensureSymlinkSync */
export declare type EnsureOptionsSymlink = {
type?: EnsureOptionsSymlinkType;
};
export declare type _EnsureOptionsSymlinkInternal = EnsureOptionsSymlink;
/** Type options for ensureSymlink and ensureSymlinkSync */
export declare type EnsureOptionsSymlinkType = "file" | "dir" | "junction";
/** @hidden */
export declare type EnsureSymlinkPathsType = {
toCwd: fs.PathLike;
toDst: fs.PathLike;
};
/** @hidden */
export declare function getOptionsDir(opt?: unknown): _EnsureOptionsDirInternal;
/** @hidden */
export declare function getOptionsFile(opt?: unknown): _EnsureOptionsFileInternal;
export declare function getSymlinkOptions(opt?: unknown): _EnsureOptionsSymlinkInternal;
export declare const getCallback: typeof util.getCallback;
export declare function areIdentical(srcStat: fs.Stats | fs.BigIntStats, dstStat: fs.Stats | fs.BigIntStats): boolean;