Yarn

https://yarnpkg.com/
Admin
Yarn is a fast, reliable, and secure package manager for JavaScript that serves as an alternative to...
Tokens:332,439
Snippets:3,305
Trust Score:9.9
Update:3 days ago
Show doc for...
Tokens:
Raw
### yarn install output example

Source: https://yarnpkg.com/blog/release/4.0

Example output from yarn install showing resolution, fetch, and link steps with package counts and sizes.

```text
➤ YN0000: · Yarn 4.0.0
➤ YN0000: ┌ Resolution step
➤ YN0085: │ + next@npm:13.5.4, react-dom@npm:18.2.0, and 24 more.
➤ YN0000: └ Completed in 0s 280ms
➤ YN0000: ┌ Fetch step
➤ YN0013: │ 22 packages were added to the project (+ 177.72 MiB).
➤ YN0000: └ Completed in 3s 723ms
➤ YN0000: ┌ Link step
➤ YN0000: └ Completed
➤ YN0000: · Done with warnings in 4s 123ms
```

--------------------------------

### start(): void

Source: https://yarnpkg.com/api/yarnpkg-core/class/LightReport

Starts the report.

```APIDOC
## start(): void

### Description
Starts the report.

### Method
start

### Signature
start(): void

### Returns
void
```

--------------------------------

### List official plugins example

Source: https://yarnpkg.com/cli/plugin/list

Example command to list the official plugins.

```bash
yarn plugin list
```

--------------------------------

### Publish the active workspace example

Source: https://yarnpkg.com/cli/npm/publish

Example of the command to publish the active workspace.

```bash
yarn npm publish
```

--------------------------------

### Clone and build a monorepo package

Source: https://yarnpkg.com/api/plugin-exec

Example script demonstrating how to clone a repository, install dependencies, pack a workspace, and extract it into the build directory.

```javascript
const pathToRepo = path.join(execEnv.tempDir, 'repo');
const pathToArchive = path.join(execEnv.tempDir, 'archive.tgz');
const pathToSubpackage = path.join(pathToRepo, 'packages/foobar');

// Clone the repository
child_process.execFileSync(`git`, [`clone`, `git@github.com:foo/bar`, pathToRepo]);

// Install the dependencies
child_process.execFileSync(`yarn`, [`install`], {cwd: pathToRepo});

// Pack a specific workspace
child_process.execFileSync(`yarn`, [`pack`, `--out`, pathToArchive], {cwd: pathToSubpackage});

// Send the package content into the build directory
child_process.execFileSync(`tar`, [`-x`, `-z`, `--strip-components=1`, `-f`, pathToArchive, `-C`, execEnv.buildDir]);
```

--------------------------------

### setup()

Source: https://yarnpkg.com/api/yarnpkg-core/class/Workspace

Sets up the workspace.

```APIDOC
## Method: setup()

### Description
Sets up the workspace.

### Parameters
None.

### Returns
- **Promise<void>** - A promise that resolves when the setup is complete.
```

--------------------------------

### Create a new plugin example

Source: https://yarnpkg.com/cli/builder/new/plugin

An example command to create a new plugin named yarn-plugin-hello-world.

```bash
yarn builder new plugin yarn-plugin-hello-world
```

--------------------------------

### start

Source: https://yarnpkg.com/api/yarnpkg-core/class/LightReport

Static method that starts a LightReport instance and executes a callback with it.

```APIDOC
## start

### Description
Static method that starts a LightReport instance and executes a callback with it.

### Method
start

### Signature
__start(opts: LightReportOptions, cb: (report: LightReport) => Promise<void>): Promise<LightReport>

### Parameters
- **opts**: LightReportOptions - Options for the report.
- **cb**: (report: LightReport) => Promise<void> - Callback receiving the report instance.

### Returns
Promise<LightReport>
```

--------------------------------

### Install project dependencies

Source: https://yarnpkg.com/cli/install

Standard command to install dependencies for a project.

```bash
yarn install
```

--------------------------------

### Focus install with production flag

Source: https://yarnpkg.com/features/workspaces

Install production dependencies for all workspaces by combining the -A flag with --production.

```bash
yarn workspaces focus -A --production
```

--------------------------------

### start

Source: https://yarnpkg.com/api/yarnpkg-core/class/StreamReport

Starts a StreamReport with the given options and callback.

```APIDOC
## start

### Description
Starts a StreamReport with the given options and callback.

### Method
start

### Signature
start(opts: StreamReportOptions, cb: (report: StreamReport) => Promise<void>): Promise<StreamReport>

### Parameters
- **opts**: StreamReportOptions
- **cb**: (report: StreamReport) => Promise<void>

### Returns
Promise<StreamReport>
```

--------------------------------

### Run yarn install

Source: https://yarnpkg.com/cli/install

Basic usage to install project dependencies.

```bash
$ yarn install
```

--------------------------------

### Install @yarnpkg/sdks

Source: https://yarnpkg.com/api/yarnpkg-sdks

Install the @yarnpkg/sdks package as a development dependency.

```bash
yarn add -D @yarnpkg/sdks
```

--------------------------------

### yarn config tree display example

Source: https://yarnpkg.com/blog/release/4.0

Example output from yarn config showing a tree display of settings with descriptions and values.

```text
├─ cacheFolder
│  ├─ Description: Folder where the cache files must be written
│  ├─ Source: 
│  └─ Value: '/Users/global/.yarn/berry/cache'
│
└─ enableHardenedMode
   ├─ Description: If true, automatically enable --check-resolutions --refresh-lockfile on installs
   ├─ Source: 
   └─ Value: null
```

--------------------------------

### Install @yarnpkg/builder

Source: https://yarnpkg.com/api/yarnpkg-builder

Install the builder as a development dependency in your project.

```bash
yarn add -D @yarnpkg/builder
```

--------------------------------

### Open the upgrade window

Source: https://yarnpkg.com/cli/upgrade-interactive

Example command to trigger the interactive upgrade window.

```bash
yarn upgrade-interactive
```

--------------------------------

### Install dependencies

Source: https://yarnpkg.com/advanced/contributing

Run this command to install dependencies; it automatically picks up changes made to the TypeScript sources.

```bash
yarn install # Will automatically pick up any changes you made to sources  
```

--------------------------------

### Example: yarn plugin runtime

Source: https://yarnpkg.com/cli/plugin/runtime

Lists the currently active plugins.

```bash
yarn plugin runtime
```

--------------------------------

### afterAllInstalled

Source: https://yarnpkg.com/api/yarnpkg-core/interface/Hooks

Called after the install method from the Project class successfully completed.

```APIDOC
## afterAllInstalled

### Description
Called after the `install` method from the `Project` class successfully completed.

### Signature
`(project: Project, options: InstallOptions) => void`

### Parameters
- **project** (Project) - Required - The project instance.
- **options** (InstallOptions) - Required - The install options.

### Returns
void
```

--------------------------------

### Show information about Lodash

Source: https://yarnpkg.com/cli/info

Example command to retrieve information about the lodash package.

```bash
yarn info lodash
```

--------------------------------

### registerPackageExtensions

Source: https://yarnpkg.com/api/yarnpkg-core/interface/Hooks

Called when the package extensions are setup. Can be used to inject new ones. That's for example what the compat plugin uses to automatically fix packages with known flaws.

```APIDOC
## registerPackageExtensions

### Description
Called when the package extensions are setup. Can be used to inject new ones. That's for example what the compat plugin uses to automatically fix packages with known flaws.

### Signature
__registerPackageExtensions?: (configuration: Configuration, registerPackageExtension: (descriptor: Descriptor, extensionData: { dependencies?: {}; peerDependencies?: {}; peerDependenciesMeta?: {} }) => void) => Promise<void>

### Parameters
- **configuration** (Configuration) - Required - The configuration object.
- **registerPackageExtension** (function) - Required - A callback to register a package extension. Takes a descriptor and extension data.
  - **descriptor** (Descriptor) - The package descriptor.
  - **extensionData** (object) - The extension data.
    - **dependencies** (object) - Optional - Additional dependencies.
    - **peerDependencies** (object) - Optional - Peer dependencies.
    - **peerDependenciesMeta** (object) - Optional - Metadata for peer dependencies.

### Returns
Promise<void>
```

--------------------------------

### setup(): Promise<void>

Source: https://yarnpkg.com/api/yarnpkg-core/class/Cache

Sets up the cache, preparing necessary directories or files.

```APIDOC
## Method: setup(): Promise<void>

### Description
Sets up the cache, preparing necessary directories or files.

### Returns
- **Promise<void>** - A promise that resolves when setup is complete.
```

--------------------------------

### Create a new package

Source: https://yarnpkg.com/cli/init

Initializes a new package in the local directory.

```bash
yarn init
```

--------------------------------

### Generate a hello world package

Source: https://yarnpkg.com/api/plugin-exec

Example script to generate a simple hello world package by writing to the build directory.

```javascript
fs.writeFileSync(path.join(execEnv.buildDir, 'package.json'), JSON.stringify({
  name: 'hello-world',
  version: '1.0.0',
}));

fs.writeFileSync(path.join(execEnv.buildDir, 'index.js'), `
  module.exports = 'hello world!';
`);
```

--------------------------------

### Build and activate @yarnpkg/plugin-exec shorthand

Source: https://yarnpkg.com/cli/plugin/import/from/sources

Example of building and activating the @yarnpkg/plugin-exec plugin using its shorthand name.

```bash
yarn plugin import from sources exec
```

--------------------------------

### get

Source: https://yarnpkg.com/api/plugin-npm/namespace/npmHttpUtils

Performs an HTTP GET request to the specified path with the given options.

```APIDOC
## get

### Description
Performs an HTTP GET request to the specified path with the given options.

### Signature
get(path: string, __namedParameters: Options): Promise<any>

### Parameters
- **path** (string) - Required - The path to send the GET request to.
- **__namedParameters** (Options) - Required - Options for the request.

### Returns
- **Promise<any>** - The response data.
```

--------------------------------

### Build and activate @yarnpkg/plugin-exec

Source: https://yarnpkg.com/cli/plugin/import/from/sources

Example of building and activating the @yarnpkg/plugin-exec plugin using its full name.

```bash
yarn plugin import from sources @yarnpkg/plugin-exec
```

--------------------------------

### Initial workspace configuration

Source: https://yarnpkg.com/features/release-workflow

Example structure of workspaces where server and client depend on common at version 1.0.0.

```text
/packages/common (1.0.0)  
/packages/server (depends on common@^1.0.0)  
/packages/client (depends on common@^1.0.0)  
```

--------------------------------

### get<K>(key: K): ConfigurationValueMap[K]

Source: https://yarnpkg.com/api/yarnpkg-core/class/Configuration

Gets a configuration value by key.

```APIDOC
## get<K>(key: K): ConfigurationValueMap[K]

### Description
Gets a configuration value by key.

### Method
get

### Type Parameters
- **K** : keyof ConfigurationValueMap

### Parameters
- **key** (K) - Required - The configuration key.

### Returns
ConfigurationValueMap[K]
```

--------------------------------

### Import local plugin from path

Source: https://yarnpkg.com/cli/plugin/import

Activates a local plugin by referencing its path on disk.

```bash
yarn plugin import ./path/to/plugin.js
```

--------------------------------

### Example package.json for a JS project

Source: https://yarnpkg.com/blog/2016/11/24/offline-mirror

A sample package.json file defining dependencies for a project that will use the offline mirror.

```json
{
  "name": "yarn-offline",
  "version": "1.0.0",
  "main": "index.js",
  "license": "MIT",
  "dependencies": {
    "is-array": "^1.0.1",
    "left-pad": "^1.1.3",
    "mime-types": "^2.1.13"
  }
}
```

--------------------------------

### Install Corepack globally

Source: https://yarnpkg.com/corepack

Installs Corepack via npm, useful for environments where it is not included by default.

```bash
npm install -g corepack
```

--------------------------------

### InstallOptions

Source: https://yarnpkg.com/api/yarnpkg-core

Options for the install process, including cache, report, and optional overrides for fetching and resolution.

```APIDOC
## InstallOptions

### Description
Options for the install process, including cache, report, and optional overrides for fetching and resolution.

### Type Declaration
- **cache**: Cache - Required - Instance of the cache that the project will use when packages have to be fetched. Some fetches may occur even during the resolution, for example when resolving git packages.
- **checkResolutions?**: boolean - Optional - If true, Yarn will check that the pre-existing resolutions found in the lockfile are coherent with the ranges that depend on them.
- **fetcher?**: Fetcher - Optional - An optional override for the default fetching pipeline. This is for overrides only - if you need to _add_ resolvers, prefer adding them through regular plugins instead.
- **immutable?**: boolean - Optional - If true, Yarn will check that the lockfile won't change after the resolution step. Additionally, after the link step, Yarn will retrieve the list of files in `immutablePatterns` and check that they didn't get modified either.
- **lockfileOnly?**: boolean - Optional - If true, Yarn will exclusively use the lockfile metadata. Setting this flag will cause it to ignore any change in the manifests, and to abort if any dependency isn't present in the lockfile.
- **mode?**: InstallMode - Optional - Changes which artifacts are generated during the install. Check the enumeration documentation for details.
- **persistProject?**: boolean - Optional - If true (the default), Yarn will update the workspace manifests once the install has completed.
- **report**: Report - Required - Provide a report instance that'll be use to store the information emitted during the install process.
- **resolver?**: Resolver - Optional - An optional override for the default resolution pipeline. This is for overrides only - if you need to _add_ resolvers, prefer adding them through regular plugins instead.
```

--------------------------------

### InstallStatus

Source: https://yarnpkg.com/api/yarnpkg-core

Represents the status of an install, including build request, install promise, and package location.

```APIDOC
## InstallStatus

### Description
Represents the status of an install, including build request, install promise, and package location.

### Type Declaration
- **buildRequest**: BuildRequest | null - Required - The build request associated with the install.
- **installPromise?**: Promise<void> - Optional - A promise that resolves when the install completes.
- **packageLocation**: PortablePath | null - Required - The location of the package being installed.
```

--------------------------------

### Install multiple packages for a single command

Source: https://yarnpkg.com/cli/dlx

Install multiple packages for a single command using the -p flag.

```bash
yarn dlx -p typescript -p ts-node ts-node --transpile-only -e "console.log('hello!')"
```

--------------------------------

### setupScriptEnvironment

Source: https://yarnpkg.com/api/yarnpkg-core/interface/Hooks

Called to set up the script environment.

```APIDOC
## setupScriptEnvironment

### Description
Called to set up the script environment.

### Signature
`(project: Project, scriptEnv: { [key: string]: string }) => Promise<void>`

### Parameters
- **project** (Project) - Required - The project instance.
- **scriptEnv** (object) - Required - The script environment variables.

### Returns
Promise<void>
```

--------------------------------

### Reject a staged package example

Source: https://yarnpkg.com/cli/npm/stage/reject

An example of rejecting a specific staged package using its unique stage ID.

```bash
yarn npm stage reject 1de6f3db-2ed9-4d72-b3dd-8f0e2b474a2f
```

--------------------------------

### Approve a staged package example

Source: https://yarnpkg.com/cli/npm/stage/approve

An example of approving a specific staged package using its unique stage ID.

```bash
yarn npm stage approve 1de6f3db-2ed9-4d72-b3dd-8f0e2b474a2f
```

--------------------------------

### Start local Docusaurus server

Source: https://yarnpkg.com/advanced/contributing

Run this command to spawn a local server and preview changes made to the documentation files.

```bash
yarn start  
```

--------------------------------

### Focus install on a specific workspace

Source: https://yarnpkg.com/features/workspaces

Install only the dependencies required for a specific workspace using the yarn workspaces focus command.

```bash
yarn workspaces focus @my-org/app
```

--------------------------------

### Run yarn info command

Source: https://yarnpkg.com/blog/release/2.3

Example of the new top-level yarn info command usage.

```bash
yarn info
```

--------------------------------

### Install Yarn from a specific branch

Source: https://yarnpkg.com/getting-started/install

Use the --branch flag to test specific pull requests when installing from sources.

```bash
yarn set version from sources --branch 1211
```

--------------------------------

### Yarn Doctor output example

Source: https://yarnpkg.com/migration/pnp

Example output from the Yarn Doctor tool showing detected issues within webpack-dev-server.

```text
➤ YN0000: Found 1 package(s) to process  
➤ YN0000: For a grand total of 236 file(s) to validate  
  
➤ YN0000: ┌ /webpack-dev-server/package.json  
➤ YN0000: │ /webpack-dev-server/test/testSequencer.js:5:19: Undeclared dependency on @jest/test-sequencer  
➤ YN0000: │ /webpack-dev-server/client-src/default/webpack.config.js:12:14: Webpack configs from non-private packages should avoid referencing loaders without require.resolve  
➤ YN0000: │ /webpack-dev-server/test/server/contentBase-option.test.js:68:8: Strings should avoid referencing the node_modules directory (prefer require.resolve)  
➤ YN0000: └ Completed in 5.12s  
  
➤ YN0000: Failed with errors in 5.12s
```

--------------------------------

### Initialize a new project

Source: https://yarnpkg.com/getting-started/install

Initialize a new project using Yarn version 2 or later.

```bash
yarn init -2
```

--------------------------------

### fetchPackageFromCache(locator: Locator, expectedChecksum: null | string, __namedParameters: { loader?: () => Promise<ZipFS>; onHit?: () => void; onMiss?: () => void } & CacheOptions): Promise<[FakeFS<PortablePath>, () => void, null | string]>

Source: https://yarnpkg.com/api/yarnpkg-core/class/Cache

Fetches a package from the cache, using a loader if the package is not present. Returns a fake filesystem, a release function, and the checksum.

```APIDOC
## Method: fetchPackageFromCache(locator: Locator, expectedChecksum: null | string, __namedParameters: { loader?: () => Promise<ZipFS>; onHit?: () => void; onMiss?: () => void } & CacheOptions): Promise<[FakeFS<PortablePath>, () => void, null | string]>

### Description
Fetches a package from the cache. If the package is not present, the loader is called to create it. The method returns a fake filesystem, a release function, and the checksum.

### Parameters
- **locator** (Locator) - Required - The locator of the package.
- **expectedChecksum** (null | string) - Required - The expected checksum of the package.
- **__namedParameters** (object) - Required - An object containing:
  - **loader** (() => Promise<ZipFS>) - Optional - A function that loads the package.
  - **onHit** (() => void) - Optional - Callback when the package is found in cache.
  - **onMiss** (() => void) - Optional - Callback when the package is not found in cache.
  - Additional CacheOptions.

### Returns
- **Promise<[FakeFS<PortablePath>, () => void, null | string]>** - A promise resolving to a tuple containing a fake filesystem, a release function, and the checksum.
```

--------------------------------

### Benchmark Gatsby installation performance with hyperfine

Source: https://yarnpkg.com/blog/release/4.0

Use the hyperfine tool to compare installation times between Yarn versions from a cold cache.

```bash
hyperfine -L v stable,canary --prepare 'rm -rf ~/.yarn/berry/cache' 'cd $(mktemp -d) && yarn init -2 && yarn set version {v} && yarn && yarn add gatsby --mode=skip-build'
```

--------------------------------

### Create a new private package

Source: https://yarnpkg.com/cli/init

Initializes a new private package in the local directory.

```bash
yarn init -p
```

--------------------------------

### getName

Source: https://yarnpkg.com/api/yarnpkg-libzip-%5Bbrowser%5D

Gets the name of an entry.

```APIDOC
## getName

### Description
Gets the name of a zip entry.

### Method
getName

### Parameters
- **...arg** (array of number) - Required - Arguments for the getName operation.

### Returns
- string
```

--------------------------------

### Find third-party plugin differences

Source: https://yarnpkg.com/cli/plugin/check

Example command to find all third-party plugins that differ from their own spec.

```bash
yarn plugin check
```

--------------------------------

### Add a package using the portal: protocol

Source: https://yarnpkg.com/protocol/portal

Use the portal: protocol to add a local folder as a package dependency.

```bash
yarn add react-dom@portal:./my-react-dom
```

--------------------------------

### startProgressSync

Source: https://yarnpkg.com/api/yarnpkg-core/class/ThrowReport

Starts a synchronous progress with a callback.

```APIDOC
## startProgressSync<T, P>(progressIt, cb)

### Description
Starts a synchronous progress with the given progress iterable and callback.

### Method
startProgressSync

### Type Parameters
- **T** - The return type of the callback.
- **P** - The progress iterable type, constrained to ProgressIterable.

### Parameters
- **progressIt** (P) - Required - The progress iterable.
- **cb** ((progressIt: P) => T) - Required - The callback function.

### Returns
T
```

--------------------------------

### startProgressPromise

Source: https://yarnpkg.com/api/yarnpkg-core/class/ThrowReport

Starts a progress promise with a callback.

```APIDOC
## startProgressPromise<T, P>(progressIt, cb)

### Description
Starts a progress promise with the given progress iterable and callback.

### Method
startProgressPromise

### Type Parameters
- **T** - The return type of the callback.
- **P** - The progress iterable type, constrained to ProgressIterable.

### Parameters
- **progressIt** (P) - Required - The progress iterable.
- **cb** ((progressIt: P) => Promise<T>) - Required - The callback function.

### Returns
Promise<T>
```

--------------------------------

### Gitignore configuration for Zero-Installs

Source: https://yarnpkg.com/getting-started/qa

Recommended .gitignore patterns for projects utilizing the Zero-Installs feature.

```text
.yarn/*  
!.yarn/cache  
!.yarn/patches  
!.yarn/plugins  
!.yarn/releases  
!.yarn/sdks  
!.yarn/versions  

```

--------------------------------

### validateProjectAfterInstall

Source: https://yarnpkg.com/api/yarnpkg-core/interface/Hooks

Called to validate the project after installation.

```APIDOC
## validateProjectAfterInstall

### Description
Called to validate the project after installation.

### Signature
`(project: Project, report: Report) => Promise<void>`

### Parameters
- **project** (Project) - Required - The project instance.
- **report** (Report) - Required - The report object.

### Returns
Promise<void>
```

--------------------------------

### struct.statS

Source: https://yarnpkg.com/api/yarnpkg-libzip-%5Bbrowser%5D

Gets the stat struct size.

```APIDOC
## struct.statS

### Description
Gets the size of the stat struct.

### Method
struct.statS

### Parameters
- **...arg** (array) - Required - Arguments for the statS operation.

### Returns
- number
```

--------------------------------

### Usage of yarn init

Source: https://yarnpkg.com/cli/init

The basic syntax for the yarn init command.

```bash
$ yarn init <initializer> ...
```

--------------------------------

### struct.statCrc

Source: https://yarnpkg.com/api/yarnpkg-libzip-%5Bbrowser%5D

Gets the CRC from a stat struct.

```APIDOC
## struct.statCrc

### Description
Gets the CRC from a stat struct.

### Method
struct.statCrc

### Parameters
- **...arg** (array of number) - Required - Arguments for the statCrc operation.

### Returns
- number
```

--------------------------------

### Import community plugin from URL

Source: https://yarnpkg.com/cli/plugin/import

Downloads and activates a community plugin from a public URL.

```bash
yarn plugin import https://example.org/path/to/plugin.js
```

--------------------------------

### struct.errorS

Source: https://yarnpkg.com/api/yarnpkg-libzip-%5Bbrowser%5D

Gets the error struct size.

```APIDOC
## struct.errorS

### Description
Gets the size of the error struct.

### Method
struct.errorS

### Parameters
- **...arg** (array) - Required - Arguments for the errorS operation.

### Returns
- number
```

--------------------------------

### Gitignore configuration without Zero-Installs

Source: https://yarnpkg.com/getting-started/qa

Recommended .gitignore patterns for projects not utilizing the Zero-Installs feature.

```text
.pnp.*  
.yarn/*  
!.yarn/patches  
!.yarn/plugins  
!.yarn/releases  
!.yarn/sdks  
!.yarn/versions  

```

--------------------------------

### statIndex

Source: https://yarnpkg.com/api/yarnpkg-libzip-%5Bbrowser%5D

Gets statistics for an entry by index.

```APIDOC
## statIndex

### Description
Gets statistics for a zip entry by index.

### Method
statIndex

### Parameters
- **...arg** (array of number) - Required - Arguments for the statIndex operation.

### Returns
- number
```

--------------------------------

### makeInstaller

Source: https://yarnpkg.com/api/plugin-nm/class/PnpLooseLinker

Creates a PnpLooseInstaller for the given link options.

```APIDOC
## makeInstaller

### Description
Creates a PnpLooseInstaller for the given link options.

### Signature
makeInstaller(opts: LinkOptions): PnpLooseInstaller

### Parameters
- opts: LinkOptions - The link options.

### Returns
PnpLooseInstaller
```

--------------------------------

### source.error

Source: https://yarnpkg.com/api/yarnpkg-libzip-%5Bbrowser%5D

Gets the error code from a source.

```APIDOC
## source.error

### Description
Gets the error code from a source.

### Method
source.error

### Parameters
- **...arg** (array of number) - Required - Arguments for the error operation.

### Returns
- number
```

--------------------------------

### getNumEntries

Source: https://yarnpkg.com/api/yarnpkg-libzip-%5Bbrowser%5D

Gets the number of entries in the archive.

```APIDOC
## getNumEntries

### Description
Gets the number of entries in the zip archive.

### Method
getNumEntries

### Parameters
- **...arg** (array of number) - Required - Arguments for the getNumEntries operation.

### Returns
- number
```

--------------------------------

### Import plugin by shorthand name

Source: https://yarnpkg.com/cli/plugin/import

Downloads and activates the '@yarnpkg/plugin-exec' plugin using its shorthand name 'exec'.

```bash
yarn plugin import exec
```

--------------------------------

### startTimerPromise

Source: https://yarnpkg.com/api/yarnpkg-core/class/Report

Starts a timer with the given description and options, executing a callback asynchronously and returning a promise.

```APIDOC
## startTimerPromise

### Description
Starts a timer with the given description and options, executing a callback asynchronously and returning a promise.

### Method
startTimerPromise

### Signature
startTimerPromise <T>(what: string, opts: TimerOptions, cb: () => Promise<T>): Promise<T>
startTimerPromise <T>(what: string, cb: () => Promise<T>): Promise<T>

### Type Parameters
- **T**

### Parameters
- **what** (string) - Required - The description of the timer.
- **opts** (TimerOptions) - Optional - The options for the timer.
- **cb** (() => Promise<T>) - Required - The callback to execute.

### Returns
Promise<T>
```

--------------------------------

### getError

Source: https://yarnpkg.com/api/yarnpkg-libzip-%5Bbrowser%5D

Gets the last error code.

```APIDOC
## getError

### Description
Gets the last error code from the zip archive.

### Method
getError

### Parameters
- **...arg** (array of number) - Required - Arguments for the getError operation.

### Returns
- number
```

--------------------------------

### AliasFS.statSync

Source: https://yarnpkg.com/api/yarnpkg-fslib/class/AliasFS

Gets file statistics synchronously.

```APIDOC
## AliasFS.statSync

### Description
Gets file statistics synchronously.

### Method
statSync

### Signature
__statSync(p: P): Stats
__statSync(p: P, opts?: StatSyncOptions & { bigint?: false; throwIfNoEntry: false }): undefined | Stats
__statSync(p: P, opts: StatSyncOptions & { bigint: true; throwIfNoEntry: false }): undefined | BigIntStats
__statSync(p: P, opts?: StatSyncOptions & { bigint?: false }): Stats
__statSync(p: P, opts: StatSyncOptions & { bigint: true }): BigIntStats
__statSync(p: P, opts: StatSyncOptions & { bigint: boolean; throwIfNoEntry?: false }): Stats | BigIntStats

### Parameters
- **p** (P) - Required - The path to stat.
- **opts** (StatSyncOptions) - Optional - Options for stat.

### Returns
Stats, BigIntStats, or undefined - The file statistics.
```

--------------------------------

### Run sdks command

Source: https://yarnpkg.com/api/yarnpkg-sdks

Execute the sdks command to generate editor SDKs and settings.

```bash
sdks
```

--------------------------------

### AliasFS.statPromise

Source: https://yarnpkg.com/api/yarnpkg-fslib/class/AliasFS

Gets file statistics asynchronously.

```APIDOC
## AliasFS.statPromise

### Description
Gets file statistics asynchronously.

### Method
statPromise

### Signature
__statPromise(p: P): Promise<Stats>
__statPromise(p: P, opts: undefined | (StatOptions & { bigint?: false })): Promise<Stats>
__statPromise(p: P, opts: StatOptions & { bigint: true }): Promise<BigIntStats>

### Parameters
- **p** (P) - Required - The path to stat.
- **opts** (StatOptions & { bigint?: false } | StatOptions & { bigint: true }) - Optional - Options for stat.

### Returns
Promise<Stats> or Promise<BigIntStats> - The file statistics.
```
Tokens:
Raw