Options
All
  • Public
  • Public/Protected
  • All
Menu

Package yarnpkg-fslib

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AliasFSOptions

AliasFSOptions<P>: object

Type parameters

Type declaration

ChangeFileOptions

ChangeFileOptions: Partial<object>

CopyOptions

CopyOptions: object

Type declaration

  • overwrite: boolean
  • stableSort: boolean
  • stableTime: boolean

CreateReadStreamOptions

CreateReadStreamOptions: Partial<object>

CreateWriteStreamOptions

CreateWriteStreamOptions: Partial<object>

CustomStatWatcherOptions

CustomStatWatcherOptions: object

Type declaration

  • Optional bigint?: undefined | false | true

CwdFSOptions

CwdFSOptions: object

Type declaration

Dirent

Dirent: Exclude<NodeDirent, "name"> & object

ExtractHintOptions

ExtractHintOptions: object

Type declaration

  • relevantExtensions: Set<string>

FSPath

FSPath<T>: T | number

Type parameters

Filename

Filename: string & object

JailFSOptions

JailFSOptions: object

Type declaration

LUTimes

LUTimes<P>: Array<[]>

Type parameters

LazyFSFactory

LazyFSFactory<P>: function

Type parameters

Type declaration

ListenerOptions

ListenerOptions: Omit<Required<WatchFileOptions>, "bigint">

MkdirOptions

MkdirOptions: Partial<object>

NativePath

NativePath: string & object

Operations

Operations: Array<function>

Path

PortablePath

PortablePath: string & object

StatWatcher

StatWatcher: EventEmitter & object

SymlinkType

SymlinkType: "file" | "dir" | "junction"

VirtualFSOptions

VirtualFSOptions: object

Type declaration

WatchCallback

WatchCallback: function

Type declaration

    • (eventType: string, filename: string): void
    • Parameters

      • eventType: string
      • filename: string

      Returns void

WatchFileCallback

WatchFileCallback: function

Type declaration

    • (current: Stats, previous: Stats): void
    • Parameters

      • current: Stats
      • previous: Stats

      Returns void

WatchFileOptions

WatchFileOptions: Partial<object>

WatchOptions

WatchOptions: Partial<object> | string

Watcher

Watcher: object

Type declaration

  • close: function
      • (): void
      • Returns void

  • on: any

WriteFileOptions

WriteFileOptions: Partial<object> | string

XFS

XFS: NodeFS & object

ZipBufferOptions

ZipBufferOptions: object

Type declaration

  • Optional level?: ZipCompression
  • libzip: Libzip
  • Optional readOnly?: undefined | false | true
  • Optional stats?: Stats

ZipCompression

ZipCompression: "mixed" | 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9

ZipOpenFSOptions

ZipOpenFSOptions: object

Type declaration

  • Optional baseFs?: FakeFS<PortablePath>
  • Optional filter?: RegExp | null
  • libzip: Libzip
  • Optional maxAge?: undefined | number

    Maximum age in ms. ZipFS instances are pruned from the cache if they aren't accessed within this amount of time.

  • Optional maxOpenFiles?: undefined | number
  • Optional readOnlyArchives?: undefined | false | true
  • Optional useCache?: undefined | false | true

ZipPathOptions

ZipPathOptions: ZipBufferOptions & object

Variables

Const DEFAULT_COMPRESSION_LEVEL

DEFAULT_COMPRESSION_LEVEL: ZipCompression = `mixed`

Const FILE_PARTS_REGEX

FILE_PARTS_REGEX: RegExp = /.*?(?<!\/)\.zip(?=\/|$)/

Const JAIL_ROOT

JAIL_ROOT: string & object = PortablePath.root

Const NUMBER_REGEXP

NUMBER_REGEXP: RegExp = /^[0-9]+$/

Const PORTABLE_PATH_REGEXP

PORTABLE_PATH_REGEXP: RegExp = /^\/([a-zA-Z]:.*)$/

Const S_IFDIR

S_IFDIR: 16384 = 16384

Const S_IFLNK

S_IFLNK: 40960 = 40960

Const S_IFMT

S_IFMT: 61440 = 61440

Const S_IFREG

S_IFREG: 32768 = 32768

Const UNC_PORTABLE_PATH_REGEXP

UNC_PORTABLE_PATH_REGEXP: RegExp = /^\/unc\/(\.dot\/)?(.*)$/

Const UNC_WINDOWS_PATH_REGEXP

UNC_WINDOWS_PATH_REGEXP: RegExp = /^\\\\(\.\\)?(.*)$/

Const VALID_COMPONENT

VALID_COMPONENT: RegExp = /^([^/]+-)?[a-f0-9]+$/

Const VIRTUAL_REGEXP

VIRTUAL_REGEXP: RegExp = /^(\/(?:[^/]+\/)*?\$\$virtual)((?:\/((?:[^/]+-)?[a-f0-9]+)(?:\/([^/]+))?)?((?:\/.*)?))$/

Const WINDOWS_PATH_REGEXP

WINDOWS_PATH_REGEXP: RegExp = /^([a-zA-Z]:.*)$/

Const ZIP_FD

ZIP_FD: 2147483648 = 2147483648

Const ZIP_FILE1

ZIP_FILE1: string & object = ppath.join(npath.toPortablePath(__dirname),`fixtures/foo.zip/foo.txt` as Filename)

Const ZIP_FILE2

ZIP_FILE2: string & object = ppath.join(npath.toPortablePath(__dirname),`fixtures/folder.zip/foo.zip/foo.txt` as Filename)

Let cleanExitRegistered

cleanExitRegistered: boolean = false

Const defaultTime

defaultTime: 315532800 = 315532800

Const nodeFs

nodeFs: NodeFS = new NodeFS()

Const npath

npath: PathUtils<NativePath> & ConvertUtils = Object.create(path) as any

Const ppath

ppath: PathUtils<PortablePath> = Object.create(path.posix) as any

Const statWatchersByFakeFS

statWatchersByFakeFS: WeakMap<FakeFS<string & object | string & object>, Map<string & object | string & object, CustomStatWatcher<string & object | string & object>>> = new WeakMap<FakeFS<Path>, Map<Path, CustomStatWatcher<Path>>>()

Const tmpdirs

tmpdirs: Set<string & object> = new Set<PortablePath>()

Const xfs

xfs: XFS = Object.assign(new NodeFS(), {detachTemp(p: PortablePath) {tmpdirs.delete(p);},mktempSync<T>(this: XFS, cb?: (p: PortablePath) => T) {registerCleanExit();while (true) {const p = getTempName(`xfs-`);try {this.mkdirSync(p);} catch (error) {if (error.code === `EEXIST`) {continue;} else {throw error;}}const realP = this.realpathSync(p);tmpdirs.add(realP);if (typeof cb !== `undefined`) {try {return cb(realP);} finally {if (tmpdirs.has(realP)) {tmpdirs.delete(realP);try {this.removeSync(realP);} catch {// Too bad if there's an error}}}} else {return p;}}},async mktempPromise<T>(this: XFS, cb?: (p: PortablePath) => Promise<T>) {registerCleanExit();while (true) {const p = getTempName(`xfs-`);try {await this.mkdirPromise(p);} catch (error) {if (error.code === `EEXIST`) {continue;} else {throw error;}}const realP = await this.realpathPromise(p);tmpdirs.add(realP);if (typeof cb !== `undefined`) {try {return await cb(realP);} finally {if (tmpdirs.has(realP)) {tmpdirs.delete(realP);try {await this.removePromise(realP);} catch {// Too bad if there's an error}}}} else {return realP;}}},async rmtempPromise() {await Promise.all(Array.from(tmpdirs.values()).map(async p => {try {await xfs.removePromise(p, {maxRetries: 0});tmpdirs.delete(p);} catch {// Too bad if there's an error}}));},rmtempSync() {for (const p of tmpdirs) {try {xfs.removeSync(p);tmpdirs.delete(p);} catch {// Too bad if there's an error}}},})

Functions

EBADF

  • EBADF(reason: string): Error & object

EBUSY

  • EBUSY(message: string): Error & object

EEXIST

  • EEXIST(reason: string): Error & object

EINVAL

  • EINVAL(reason: string): Error & object

EISDIR

  • EISDIR(reason: string): Error & object

ENOENT

  • ENOENT(reason: string): Error & object

ENOSYS

  • ENOSYS(message: string, reason: string): Error & object

ENOTDIR

  • ENOTDIR(reason: string): Error & object

ENOTEMPTY

  • ENOTEMPTY(reason: string): Error & object

EOPNOTSUPP

  • EOPNOTSUPP(reason: string): Error & object

EROFS

  • EROFS(reason: string): Error & object

areStatsEqual

  • areStatsEqual(a: Stats, b: Stats): boolean

assertStatus

  • assertStatus<T>(current: Status, expected: T): current

Const contains

  • contains<T>(pathUtils: PathUtils<T>, from: T, to: T): null | T

convertPath

  • convertPath<P>(targetPathUtils: PathUtils<P>, sourcePath: Path): P

copyFile

  • copyFile<P1, P2>(prelayout: Operations, postlayout: Operations, updateTime: typeof utimesPromise, destinationFs: FakeFS<P1>, destination: P1, destinationStat: Stats | null, sourceFs: FakeFS<P2>, source: P2, sourceStat: Stats, opts: CopyOptions): Promise<void>

copyFolder

  • copyFolder<P1, P2>(prelayout: Operations, postlayout: Operations, updateTime: typeof utimesPromise, destinationFs: FakeFS<P1>, destination: P1, destinationStat: Stats | null, sourceFs: FakeFS<P2>, source: P2, sourceStat: Stats, opts: CopyOptions): Promise<void>

copyImpl

copyPromise

  • copyPromise<P1, P2>(destinationFs: FakeFS<P1>, destination: P1, sourceFs: FakeFS<P2>, source: P2, opts: CopyOptions): Promise<void>

copySymlink

  • copySymlink<P1, P2>(prelayout: Operations, postlayout: Operations, updateTime: typeof utimesPromise, destinationFs: FakeFS<P1>, destination: P1, destinationStat: Stats | null, sourceFs: FakeFS<P2>, source: P2, sourceStat: Stats, opts: CopyOptions): Promise<void>

extendFs

fromPortablePath

getEndOfLine

  • getEndOfLine(content: string): string

getTempName

  • getTempName(prefix: string): string & object

makeDefaultStats

makeEmptyStats

  • makeEmptyStats(): StatEntry & object & object

makeError

  • makeError(code: string, message: string): Error & object

Const makeError

  • makeError(): Error & object

maybeLStat

  • maybeLStat<P>(baseFs: FakeFS<P>, p: P): Promise<null | Stats>

normalizeLineEndings

  • normalizeLineEndings(originalContent: string, newContent: string): string

patchFs

registerCleanExit

  • registerCleanExit(): void

toFilename

  • toFilename(filename: string): Filename

toPortablePath

toUnixTimestamp

  • toUnixTimestamp(time: Date | string | number): string | number | Date

unwatchAllFiles

unwatchFile

useFakeTime

  • useFakeTime(cb: function): Promise<void>
  • Parameters

    • cb: function
        • (advanceTimeBy: function): void | Promise<void>
        • Parameters

          • advanceTimeBy: function
              • (ms: number): void
              • Parameters

                • ms: number

                Returns void

          Returns void | Promise<void>

    Returns Promise<void>

watchFile

Object literals

Const Filename

Filename: object

lockfile

lockfile: string & object = `yarn.lock` as Filename

manifest

manifest: string & object = `package.json` as Filename

nodeModules

nodeModules: string & object = `node_modules` as Filename

pnpJs

pnpJs: string & object = `.pnp.js` as Filename

rc

rc: string & object = `.yarnrc.yml` as Filename

Const PortablePath

PortablePath: object

dot

dot: string & object = `.` as PortablePath

root

root: string & object = `/` as PortablePath

Generated using TypeDoc