On this page

Source Code: lib/util/fs.js#L322

Returns location of targetPath relative to rootPath.

inputFileSystem.dirname(dirname): string
Source Code: lib/util/fs.js#L340
Attributes
dirname:string
Returns:string
inputFileSystem.join(path1, path2): string
Source Code: lib/util/fs.js#L338
Attributes
path1:string
path2:string
Returns:string
inputFileSystem.lstat(path, callback): void
Source Code: lib/util/fs.js#L331
Attributes
path:PathLikeFs
callback:(err: ErrnoException | null, result?: IStatsFs) => void
inputFileSystem.lstat(path, options, callback): void
Source Code: lib/util/fs.js#L331
Attributes
path:PathLikeFs
options:StatOptionsFs & { bigint?: false } | undefined
callback:(err: ErrnoException | null, result?: IStatsFs) => void
inputFileSystem.lstat(path, options, callback): void
Source Code: lib/util/fs.js#L331
Attributes
path:PathLikeFs
options:StatOptionsFs & { bigint: true }
callback:(err: ErrnoException | null, result?: IBigIntStatsFs) => void
inputFileSystem.lstat(path, options, callback): void
Source Code: lib/util/fs.js#L331
Attributes
path:PathLikeFs
options:StatOptionsFs | undefined
callback:(err: ErrnoException | null, result?: IStatsFs | IBigIntStatsFs) => void
inputFileSystem.lstatSync(path): IStatsFs
Source Code: lib/util/fs.js#L332
Attributes
path:PathLikeFs
Returns:IStatsFs
inputFileSystem.lstatSync(path, options?): IStatsFs
Source Code: lib/util/fs.js#L332
Attributes
path:PathLikeFs
options:StatSyncOptions & { bigint?: false; throwIfNoEntry?: true }
Returns:IStatsFs
inputFileSystem.lstatSync(path, options): IBigIntStatsFs
Source Code: lib/util/fs.js#L332
Attributes
path:PathLikeFs
options:StatSyncOptions & { bigint: true; throwIfNoEntry?: true }
Returns:IBigIntStatsFs
inputFileSystem.lstatSync(path, options?): IStatsFs | undefined
Source Code: lib/util/fs.js#L332
Attributes
path:PathLikeFs
options:StatSyncOptions & { bigint?: false; throwIfNoEntry: false }
Returns:IStatsFs | undefined
inputFileSystem.lstatSync(path, options): IBigIntStatsFs | undefined
Source Code: lib/util/fs.js#L332
Attributes
path:PathLikeFs
options:StatSyncOptions & { bigint: true; throwIfNoEntry: false }
Returns:IBigIntStatsFs | undefined
inputFileSystem.lstatSync(path, options): IStatsFs | IBigIntStatsFs
Source Code: lib/util/fs.js#L332
Attributes
path:PathLikeFs
options:StatSyncOptions & { bigint: boolean; throwIfNoEntry?: true }
Returns:IStatsFs | IBigIntStatsFs
inputFileSystem.lstatSync(path, options?): IStatsFs | IBigIntStatsFs | undefined
Source Code: lib/util/fs.js#L332
Attributes
path:PathLikeFs
options:StatSyncOptions
Returns:IStatsFs | IBigIntStatsFs | undefined
inputFileSystem.purge(value?, options?): void
Source Code: lib/util/fs.js#L337
Attributes
value:string | string[] | Set<string>
options:Object
exact:boolean
inputFileSystem.readdir(path, options, callback): void
Source Code: lib/util/fs.js#L327
Attributes
path:PathLikeFs
options:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | Object | null | undefined
encoding:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | null
recursive:boolean
withFileTypes:false
callback:(err: ErrnoException | null, files?: string[]) => void
inputFileSystem.readdir(path, options, callback): void
Source Code: lib/util/fs.js#L327
Attributes
path:PathLikeFs
options:"buffer" | Object
encoding:"buffer"
recursive:boolean
withFileTypes:false
callback:(err: ErrnoException | null, files?: Buffer<ArrayBufferLike>[]) => void
inputFileSystem.readdir(path, options, callback): void
Source Code: lib/util/fs.js#L327
Attributes
path:PathLikeFs
options:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | ObjectEncodingOptionsFs & { recursive?: boolean; withFileTypes?: false } | null | undefined
callback:(err: ErrnoException | null, files?: string[] | Buffer<ArrayBufferLike>[]) => void
inputFileSystem.readdir(path, callback): void
Source Code: lib/util/fs.js#L327
Attributes
path:PathLikeFs
callback:(err: ErrnoException | null, files?: string[]) => void
inputFileSystem.readdir(path, options, callback): void
Source Code: lib/util/fs.js#L327
Attributes
path:PathLikeFs
options:ObjectEncodingOptionsFs & { recursive?: boolean; withFileTypes: true }
callback:(err: ErrnoException | null, files?: DirentFs<string>[]) => void
inputFileSystem.readdir(path, options, callback): void
Source Code: lib/util/fs.js#L327
Attributes
path:PathLikeFs
options:Object
encoding:"buffer"
recursive:boolean
withFileTypes:true
callback:(err: ErrnoException | null, files: DirentFs<Buffer<ArrayBufferLike>>[]) => void
inputFileSystem.readdirSync(path, options?): string[]
Source Code: lib/util/fs.js#L328
Attributes
path:PathLikeFs
options:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | Object | null
encoding:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | null
recursive:boolean
withFileTypes:false
Returns:string[]
inputFileSystem.readdirSync(path, options): Buffer<ArrayBufferLike>[]
Source Code: lib/util/fs.js#L328
Attributes
path:PathLikeFs
options:"buffer" | Object
encoding:"buffer"
recursive:boolean
withFileTypes:false
Returns:Buffer<ArrayBufferLike>[]
inputFileSystem.readdirSync(path, options?): string[] | Buffer<ArrayBufferLike>[]
Source Code: lib/util/fs.js#L328
Attributes
path:PathLikeFs
options:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | ObjectEncodingOptionsFs & { recursive?: boolean; withFileTypes?: false } | null
Returns:string[] | Buffer<ArrayBufferLike>[]
inputFileSystem.readdirSync(path, options): DirentFs<string>[]
Source Code: lib/util/fs.js#L328
Attributes
path:PathLikeFs
options:ObjectEncodingOptionsFs & { recursive?: boolean; withFileTypes: true }
Returns:DirentFs<string>[]
inputFileSystem.readdirSync(path, options): DirentFs<Buffer<ArrayBufferLike>>[]
Source Code: lib/util/fs.js#L328
Attributes
path:PathLikeFs
options:Object
encoding:"buffer"
recursive:boolean
withFileTypes:true
Returns:DirentFs<Buffer<ArrayBufferLike>>[]
inputFileSystem.readFile(path, options, callback): void
Source Code: lib/util/fs.js#L323
Attributes
path:PathOrFileDescriptorFs
options:{ encoding?: null; flag?: string } & Abortable | null | undefined
callback:(err: ErrnoException | null, result?: Buffer<ArrayBufferLike>) => void
inputFileSystem.readFile(path, options, callback): void
Source Code: lib/util/fs.js#L323
Attributes
path:PathOrFileDescriptorFs
options:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | { encoding: BufferEncoding; flag?: string } & Abortable
callback:(err: ErrnoException | null, result?: string) => void
inputFileSystem.readFile(path, options, callback): void
Source Code: lib/util/fs.js#L323
Attributes
path:PathOrFileDescriptorFs
options:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | ObjectEncodingOptionsFs & { flag?: string } & Abortable | null | undefined
callback:(err: ErrnoException | null, result?: string | Buffer<ArrayBufferLike>) => void
inputFileSystem.readFile(path, callback): void
Source Code: lib/util/fs.js#L323
Attributes
path:PathOrFileDescriptorFs
callback:(err: ErrnoException | null, result?: Buffer<ArrayBufferLike>) => void
inputFileSystem.readFileSync(path, options?): Buffer
Source Code: lib/util/fs.js#L324
Attributes
path:PathOrFileDescriptorFs
options:Object | null
encoding:null
flag:string
Returns:Buffer
inputFileSystem.readFileSync(path, options): string
Source Code: lib/util/fs.js#L324
Attributes
path:PathOrFileDescriptorFs
options:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | Object
encoding:BufferEncoding
flag:string
Returns:string
inputFileSystem.readFileSync(path, options?): string | Buffer<ArrayBufferLike>
Source Code: lib/util/fs.js#L324
Attributes
path:PathOrFileDescriptorFs
options:"ascii" | "utf8" | "utf-8" | "utf16le" | "utf-16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex" | ObjectEncodingOptionsFs & { flag?: string } | null
Returns:string | Buffer<ArrayBufferLike>
inputFileSystem.readJson(pathOrFileDescriptor, callback): void
Source Code: lib/util/fs.js#L335
Attributes
pathOrFileDescriptor:PathOrFileDescriptorFs
callback:(err: Error | ErrnoException | null, result?: JsonObjectFs) => void
inputFileSystem.readJsonSync(pathOrFileDescriptor): JsonObjectFs
Source Code: lib/util/fs.js#L336
Attributes
pathOrFileDescriptor:PathOrFileDescriptorFs
Returns:JsonObjectFs
inputFileSystem.readlink(path, options, callback): void
Source Code: lib/util/fs.js#L325
Attributes
path:PathLikeFs
options:EncodingOptionFs
callback:(err: ErrnoException | null, result?: string) => void
inputFileSystem.readlink(path, options, callback): void
Source Code: lib/util/fs.js#L325
Attributes
path:PathLikeFs
options:BufferEncodingOption
callback:(err: ErrnoException | null, result?: Buffer<ArrayBufferLike>) => void
inputFileSystem.readlink(path, options, callback): void
Source Code: lib/util/fs.js#L325
Attributes
path:PathLikeFs
options:EncodingOptionFs
callback:(err: ErrnoException | null, result?: string | Buffer<ArrayBufferLike>) => void
inputFileSystem.readlink(path, callback): void
Source Code: lib/util/fs.js#L325
Attributes
path:PathLikeFs
callback:(err: ErrnoException | null, result?: string) => void
inputFileSystem.readlinkSync(path, options?): string
Source Code: lib/util/fs.js#L326
Attributes
path:PathLikeFs
options:EncodingOptionFs
Returns:string
inputFileSystem.readlinkSync(path, options): Buffer
Source Code: lib/util/fs.js#L326
Attributes
path:PathLikeFs
options:BufferEncodingOption
Returns:Buffer
inputFileSystem.readlinkSync(path, options?): string | Buffer<ArrayBufferLike>
Source Code: lib/util/fs.js#L326
Attributes
path:PathLikeFs
options:EncodingOptionFs
Returns:string | Buffer<ArrayBufferLike>
inputFileSystem.realpath(path, options, callback): void
Source Code: lib/util/fs.js#L333
Attributes
path:PathLikeFs
options:EncodingOptionFs
callback:(err: ErrnoException | null, result?: string) => void
inputFileSystem.realpath(path, options, callback): void
Source Code: lib/util/fs.js#L333
Attributes
path:PathLikeFs
options:BufferEncodingOption
callback:(err: ErrnoException | null, result?: Buffer<ArrayBufferLike>) => void
inputFileSystem.realpath(path, options, callback): void
Source Code: lib/util/fs.js#L333
Attributes
path:PathLikeFs
options:EncodingOptionFs
callback:(err: ErrnoException | null, result?: string | Buffer<ArrayBufferLike>) => void
inputFileSystem.realpath(path, callback): void
Source Code: lib/util/fs.js#L333
Attributes
path:PathLikeFs
callback:(err: ErrnoException | null, result?: string) => void
inputFileSystem.realpathSync(path, options?): string
Source Code: lib/util/fs.js#L334
Attributes
path:PathLikeFs
options:EncodingOptionFs
Returns:string
inputFileSystem.realpathSync(path, options): Buffer
Source Code: lib/util/fs.js#L334
Attributes
path:PathLikeFs
options:BufferEncodingOption
Returns:Buffer
inputFileSystem.realpathSync(path, options?): string | Buffer<ArrayBufferLike>
Source Code: lib/util/fs.js#L334
Attributes
path:PathLikeFs
options:EncodingOptionFs
Returns:string | Buffer<ArrayBufferLike>
inputFileSystem.relative(from, to): string
Source Code: lib/util/fs.js#L339
Attributes
from:string
to:string
Returns:string
inputFileSystem.stat(path, callback): void
Source Code: lib/util/fs.js#L329
Attributes
path:PathLikeFs
callback:(err: ErrnoException | null, result?: IStatsFs) => void
inputFileSystem.stat(path, options, callback): void
Source Code: lib/util/fs.js#L329
Attributes
path:PathLikeFs
options:StatOptionsFs & { bigint?: false } | undefined
callback:(err: ErrnoException | null, result?: IStatsFs) => void
inputFileSystem.stat(path, options, callback): void
Source Code: lib/util/fs.js#L329
Attributes
path:PathLikeFs
options:StatOptionsFs & { bigint: true }
callback:(err: ErrnoException | null, result?: IBigIntStatsFs) => void
inputFileSystem.stat(path, options, callback): void
Source Code: lib/util/fs.js#L329
Attributes
path:PathLikeFs
options:StatOptionsFs | undefined
callback:(err: ErrnoException | null, result?: IStatsFs | IBigIntStatsFs) => void
inputFileSystem.statSync(path): IStatsFs
Source Code: lib/util/fs.js#L330
Attributes
path:PathLikeFs
Returns:IStatsFs
inputFileSystem.statSync(path, options?): IStatsFs
Source Code: lib/util/fs.js#L330
Attributes
path:PathLikeFs
options:StatSyncOptions & { bigint?: false; throwIfNoEntry?: true }
Returns:IStatsFs
inputFileSystem.statSync(path, options): IBigIntStatsFs
Source Code: lib/util/fs.js#L330
Attributes
path:PathLikeFs
options:StatSyncOptions & { bigint: true; throwIfNoEntry?: true }
Returns:IBigIntStatsFs
inputFileSystem.statSync(path, options?): IStatsFs | undefined
Source Code: lib/util/fs.js#L330
Attributes
path:PathLikeFs
options:StatSyncOptions & { bigint?: false; throwIfNoEntry: false }
Returns:IStatsFs | undefined
inputFileSystem.statSync(path, options): IBigIntStatsFs | undefined
Source Code: lib/util/fs.js#L330
Attributes
path:PathLikeFs
options:StatSyncOptions & { bigint: true; throwIfNoEntry: false }
Returns:IBigIntStatsFs | undefined
inputFileSystem.statSync(path, options): IStatsFs | IBigIntStatsFs
Source Code: lib/util/fs.js#L330
Attributes
path:PathLikeFs
options:StatSyncOptions & { bigint: boolean; throwIfNoEntry?: true }
Returns:IStatsFs | IBigIntStatsFs
inputFileSystem.statSync(path, options?): IStatsFs | IBigIntStatsFs | undefined
Source Code: lib/util/fs.js#L330
Attributes
path:PathLikeFs
options:StatSyncOptions
Returns:IStatsFs | IBigIntStatsFs | undefined