Interface FS

interface FS {
    contains?: ((root: string, file: string) => boolean);
    dirname?: ((file: string) => string);
    exists: ((filepath: string) => Promise<boolean>);
    existsSync: ((filepath: string) => boolean);
    fallback?: ((file: string) => undefined | string);
    readFile: ((filepath: string) => Promise<string>);
    readFileSync: ((filepath: string) => string);
    resolve: ((dir: string, file: string, ext: string) => string);
    sep?: string;
}

Properties

contains? dirname? exists existsSync fallback? readFile readFileSync resolve sep?

Properties

Optionalcontains

contains?: ((root: string, file: string) => boolean)

check if file is contained in root, always return true by default. Warning: not setting this could expose path traversal vulnerabilities.

Optionaldirname

dirname?: ((file: string) => string)

required for relative path resolving

exists

exists: ((filepath: string) => Promise<boolean>)

check if a file exists asynchronously

existsSync

existsSync: ((filepath: string) => boolean)

check if a file exists synchronously

Optionalfallback

fallback?: ((file: string) => undefined | string)

fallback file for lookup failure

readFile

readFile: ((filepath: string) => Promise<string>)

read a file asynchronously

readFileSync

readFileSync: ((filepath: string) => string)

read a file synchronously

resolve

resolve: ((dir: string, file: string, ext: string) => string)

resolve a file against directory, for given ext option

Optionalsep

sep?: string

defaults to "/"

Settings

Member Visibility

On This Page

Properties