Search
Preparing search index...
The search index is not available
Yarn API
Home
Configuration
Features
CLI
Advanced
GitHub
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
.pnp
BasePortableFakeFS
Globals
Generic Packages
@yarnpkg/core
@yarnpkg/fslib
@yarnpkg/libzip
@yarnpkg/nm
@yarnpkg/parsers
@yarnpkg/pnp
@yarnpkg/pnpify
@yarnpkg/sdks
@yarnpkg/shell
Yarn Packages
@yarnpkg/builder
@yarnpkg/cli
Default Plugins
@yarnpkg/plugin-compat
@yarnpkg/plugin-dlx
@yarnpkg/plugin-essentials
@yarnpkg/plugin-file
@yarnpkg/plugin-git
@yarnpkg/plugin-github
@yarnpkg/plugin-http
@yarnpkg/plugin-init
@yarnpkg/plugin-link
@yarnpkg/plugin-nm
@yarnpkg/plugin-npm
@yarnpkg/plugin-npm-cli
@yarnpkg/plugin-pack
@yarnpkg/plugin-patch
@yarnpkg/plugin-pnp
Contrib Plugins
@yarnpkg/plugin-constraints
@yarnpkg/plugin-exec
@yarnpkg/plugin-interactive-tools
@yarnpkg/plugin-stage
@yarnpkg/plugin-typescript
@yarnpkg/plugin-version
@yarnpkg/plugin-workspace-tools
Class BasePortableFakeFS
Hierarchy
FakeFS
BasePortableFakeFS
NodeFS
MountFS
ZipFS
Constructors
constructor
Methods
changeFileBufferPromise
changeFileBufferSync
changeFilePromise
changeFileSync
changeFileTextPromise
changeFileTextSync
checksumFilePromise
copyPromise
copySync
genTraversePromise
lockPromise
mkdirpPromise
mkdirpSync
movePromise
moveSync
preserveTimePromise
preserveTimeSync
readJsonPromise
readJsonSync
removePromise
removeSync
writeJsonPromise
writeJsonSync
Constructors
constructor
new
Base
Portable
FakeFS
(
)
:
BasePortableFakeFS
Returns
BasePortableFakeFS
Methods
change
File
Buffer
Promise
change
File
Buffer
Promise
(
p
:
any
, content
:
any
, __namedParameters
?:
object
)
:
Promise
<
void
>
Parameters
p:
any
content:
any
Default value
__namedParameters:
object
= {}
mode
:
any
Returns
Promise
<
void
>
change
File
Buffer
Sync
change
File
Buffer
Sync
(
p
:
any
, content
:
any
, __namedParameters
?:
object
)
:
void
Parameters
p:
any
content:
any
Default value
__namedParameters:
object
= {}
mode
:
any
Returns
void
change
File
Promise
change
File
Promise
(
p
:
any
, content
:
any
, opts
?:
object
)
:
Promise
<
void
>
Parameters
p:
any
content:
any
Default value
opts:
object
= {}
Returns
Promise
<
void
>
change
File
Sync
change
File
Sync
(
p
:
any
, content
:
any
, opts
?:
object
)
:
void
Parameters
p:
any
content:
any
Default value
opts:
object
= {}
Returns
void
change
File
Text
Promise
change
File
Text
Promise
(
p
:
any
, content
:
any
, __namedParameters
?:
object
)
:
Promise
<
void
>
Parameters
p:
any
content:
any
Default value
__namedParameters:
object
= {}
automatic
Newlines
:
any
mode
:
any
Returns
Promise
<
void
>
change
File
Text
Sync
change
File
Text
Sync
(
p
:
any
, content
:
any
, __namedParameters
?:
object
)
:
void
Parameters
p:
any
content:
any
Default value
__namedParameters:
object
= {}
automatic
Newlines
:
boolean
mode
:
any
Returns
void
checksum
File
Promise
checksum
File
Promise
(
path
:
any
, __namedParameters
?:
object
)
:
Promise
<
string
>
Parameters
path:
any
Default value
__namedParameters:
object
= {}
algorithm
:
string
Returns
Promise
<
string
>
copy
Promise
copy
Promise
(
destination
:
any
, source
:
any
, __namedParameters
?:
object
)
:
Promise
<
void
>
Parameters
destination:
any
source:
any
Default value
__namedParameters:
object
= {}
base
Fs
:
this
link
Strategy
:
null
overwrite
:
boolean
stable
Sort
:
boolean
stable
Time
:
boolean
Returns
Promise
<
void
>
copy
Sync
copy
Sync
(
destination
:
any
, source
:
any
, __namedParameters
?:
object
)
:
void
Parameters
destination:
any
source:
any
Default value
__namedParameters:
object
= {}
base
Fs
:
this
overwrite
:
boolean
Returns
void
gen
Traverse
Promise
gen
Traverse
Promise
(
init
:
any
, __namedParameters
?:
object
)
:
AsyncGenerator
<
any
,
void
,
unknown
>
Parameters
init:
any
Default value
__namedParameters:
object
= {}
stable
Sort
:
boolean
Returns
AsyncGenerator
<
any
,
void
,
unknown
>
lock
Promise
lock
Promise
(
affectedPath
:
any
, callback
:
any
)
:
Promise
<
any
>
Parameters
affectedPath:
any
callback:
any
Returns
Promise
<
any
>
mkdirp
Promise
mkdirp
Promise
(
p
:
any
, __namedParameters
?:
object
)
:
Promise
<
any
>
Parameters
p:
any
Default value
__namedParameters:
object
= {}
chmod
:
any
utimes
:
any
Returns
Promise
<
any
>
mkdirp
Sync
mkdirp
Sync
(
p
:
any
, __namedParameters
?:
object
)
:
any
Parameters
p:
any
Default value
__namedParameters:
object
= {}
chmod
:
any
utimes
:
any
Returns
any
move
Promise
move
Promise
(
fromP
:
any
, toP
:
any
)
:
Promise
<
void
>
Parameters
fromP:
any
toP:
any
Returns
Promise
<
void
>
move
Sync
move
Sync
(
fromP
:
any
, toP
:
any
)
:
void
Parameters
fromP:
any
toP:
any
Returns
void
preserve
Time
Promise
preserve
Time
Promise
(
p
:
any
, cb
:
any
)
:
Promise
<
void
>
Parameters
p:
any
cb:
any
Returns
Promise
<
void
>
preserve
Time
Sync
preserve
Time
Sync
(
p
:
any
, cb
:
any
)
:
Promise
<
void
>
Parameters
p:
any
cb:
any
Returns
Promise
<
void
>
read
Json
Promise
read
Json
Promise
(
p
:
any
)
:
Promise
<
any
>
Parameters
p:
any
Returns
Promise
<
any
>
read
Json
Sync
read
Json
Sync
(
p
:
any
)
:
any
Parameters
p:
any
Returns
any
remove
Promise
remove
Promise
(
p
:
any
, __namedParameters
?:
object
)
:
Promise
<
void
>
Parameters
p:
any
Default value
__namedParameters:
object
= {}
max
Retries
:
number
recursive
:
boolean
Returns
Promise
<
void
>
remove
Sync
remove
Sync
(
p
:
any
, __namedParameters
?:
object
)
:
void
Parameters
p:
any
Default value
__namedParameters:
object
= {}
recursive
:
boolean
Returns
void
write
Json
Promise
write
Json
Promise
(
p
:
any
, data
:
any
)
:
Promise
<
any
>
Parameters
p:
any
data:
any
Returns
Promise
<
any
>
write
Json
Sync
write
Json
Sync
(
p
:
any
, data
:
any
)
:
any
Parameters
p:
any
data:
any
Returns
any
".pnp"
Base
Portable
FakeFS
constructor
change
File
Buffer
Promise
change
File
Buffer
Sync
change
File
Promise
change
File
Sync
change
File
Text
Promise
change
File
Text
Sync
checksum
File
Promise
copy
Promise
copy
Sync
gen
Traverse
Promise
lock
Promise
mkdirp
Promise
mkdirp
Sync
move
Promise
move
Sync
preserve
Time
Promise
preserve
Time
Sync
read
Json
Promise
read
Json
Sync
remove
Promise
remove
Sync
write
Json
Promise
write
Json
Sync
Generated using
TypeDoc