Skip to content

API > wxt > WxtPackageManager

Interface: WxtPackageManager

Package management utils built on top of nypm

Contents

Extends

  • PackageManager

Properties

addDependency

addDependency: (name, options?) => Promise<void>

Adds dependency to the project.

Parameters

name: string | string[]

Name of the dependency to add.

options?: OperationOptions

Options to pass to the API call.

Source

src/types/index.ts:1189


addDevDependency

addDevDependency: (name, options?) => Promise<void>

Adds dev dependency to the project.

Parameters

name: string | string[]

Name of the dev dependency to add.

options?: Omit<OperationOptions, "dev">

Options to pass to the API call.

Source

src/types/index.ts:1190


command

command: string

Inherited from

Nypm.PackageManager.command

Source

node_modules/.pnpm/nypm@0.3.6/node_modules/nypm/dist/index.d.ts:4


downloadDependency

downloadDependency: (id, downloadDir) => Promise<string>

Download a package's TGZ file and move it into the downloadDir. Use's npm pack <name>, so you must have setup authorization in .npmrc file, regardless of the package manager used.

Parameters

id: string

Name of the package to download, can include a version (like wxt@0.17.1)

downloadDir: string

Where to store the package.

Returns

Absolute path to downloaded file.

Source

src/types/index.ts:1202


ensureDependencyInstalled

ensureDependencyInstalled: (name, options?) => Promise<true | undefined>

Ensures dependency is installed.

Parameters

name: string

Name of the dependency.

options?: Pick<OperationOptions, "workspace" | "dev" | "cwd">

Options to pass to the API call.

Source

src/types/index.ts:1191


files

files?: string[]

Inherited from

Nypm.PackageManager.files

Source

node_modules/.pnpm/nypm@0.3.6/node_modules/nypm/dist/index.d.ts:8


installDependencies

installDependencies: (options?) => Promise<void>

Installs project dependencies.

Parameters

options?: Pick<OperationOptions, "silent" | "cwd" | "packageManager">

Options to pass to the API call.

Source

src/types/index.ts:1192


listDependencies

listDependencies: (options?) => Promise<Dependency[]>

Run npm ls, pnpm ls, or bun pm ls, or yarn list and return the results.

WARNING: Yarn always returns all dependencies

Parameters

options?: object

options.all?: boolean

options.cwd?: string

Source

src/types/index.ts:1208


lockFile

lockFile?: string

Inherited from

Nypm.PackageManager.lockFile

Source

node_modules/.pnpm/nypm@0.3.6/node_modules/nypm/dist/index.d.ts:7


majorVersion

majorVersion?: string

Inherited from

Nypm.PackageManager.majorVersion

Source

node_modules/.pnpm/nypm@0.3.6/node_modules/nypm/dist/index.d.ts:6


name

name: PackageManagerName

Inherited from

Nypm.PackageManager.name

Source

node_modules/.pnpm/nypm@0.3.6/node_modules/nypm/dist/index.d.ts:3


overridesKey

overridesKey: string

Key used to override package versions. Sometimes called "resolutions".

Source

src/types/index.ts:1215


removeDependency

removeDependency: (name, options?) => Promise<void>

Removes dependency from the project.

Parameters

name: string

Name of the dependency to remove.

options?: OperationOptions

Options to pass to the API call.

Source

src/types/index.ts:1193


version

version?: string

Inherited from

Nypm.PackageManager.version

Source

node_modules/.pnpm/nypm@0.3.6/node_modules/nypm/dist/index.d.ts:5


Generated using typedoc-plugin-markdown and TypeDoc