Interface CheckPackageApi

interface CheckPackageApi {
    checkDirectDuplicateDependencies: (
        options?: CheckDirectDuplicateDependenciesOptions,
    ) => CheckPackageApi;
    checkDirectPeerDependencies: (
        options?: CheckDirectPeerDependenciesOptions,
    ) => CheckPackageApi;
    checkExactDevVersions: (
        options?: CheckExactVersionsOptions,
    ) => CheckPackageApi;
    checkExactVersions: (
        options?: CheckExactVersionsOptions,
    ) => CheckPackageApi;
    checkIdenticalVersions: (
        dependencies: {
            dependencies?: Record<string, string[]>;
            devDependencies?: Record<string, string[]>;
            resolutions?: Record<string, string[]>;
        },
    ) => CheckPackageApi;
    checkIdenticalVersionsThanDependency: (
        depName: string,
        dependencies: {
            dependencies?: string[];
            devDependencies?: string[];
            resolutions?: string[];
        },
    ) => CheckPackageApi;
    checkIdenticalVersionsThanDevDependencyOfDependency: (
        depName: string,
        dependencies: {
            dependencies?: string[];
            devDependencies?: string[];
            resolutions?: string[];
        },
    ) => CheckPackageApi;
    checkMinRangeDependenciesSatisfiesDevDependencies: () => CheckPackageApi;
    checkMinRangePeerDependenciesSatisfiesDependencies: () => CheckPackageApi;
    checkNoDependencies: (
        type?: DependencyTypes,
        moveToSuggestion?: DependencyTypes,
    ) => CheckPackageApi;
    checkRecommended: (options?: CheckRecommendedOptions) => CheckPackageApi;
    checkResolutionsHasExplanation: (
        checkMessage?: CheckResolutionMessage,
    ) => CheckPackageApi;
    checkResolutionsVersionsMatch: () => CheckPackageApi;
    checkSatisfiesVersions: (
        dependencies: Partial<
            Record<DependencyTypes, Record<DependencyName, string>>,
        >,
    ) => CheckPackageApi;
    checkSatisfiesVersionsBetweenDependencies: (
        config: Record<
            string,
            {
                dependencies?: Record<
                    string,
                    { dependencies?: string[]; devDependencies?: string[] },
                >;
                devDependencies?: Record<
                    string,
                    { dependencies?: string[]; devDependencies?: string[] },
                >;
            },
        >,
    ) => CheckPackageApi;
    checkSatisfiesVersionsFromDependency: (
        depName: string,
        dependencies: {
            dependencies?: string[];
            devDependencies?: string[];
            resolutions?: string[];
        },
    ) => CheckPackageApi;
    checkSatisfiesVersionsInDependency: (
        depName: string,
        dependenciesRanges: DependenciesRanges,
    ) => CheckPackageApi;
    checkSatisfiesVersionsInDevDependenciesOfDependency: (
        depName: string,
        dependencies: {
            dependencies?: string[];
            devDependencies?: string[];
            resolutions?: string[];
        },
    ) => CheckPackageApi;
    getDependencyPackageJson: GetDependencyPackageJson;
    isPkgLibrary: boolean;
    parsedPkg: ParsedPackageJson;
    pkg: {
        author?: Person;
        bin?: string
        | Partial<Record<string, string>>;
        browser?: string | Partial<Record<string, string | false>>;
        bugs?: BugsLocation;
        bundledDependencies?: string[];
        bundleDependencies?: string[];
        config?: JsonObject;
        contributors?: Person[];
        cpu?: LiteralUnion<
            | "arm"
            | "arm64"
            | "ia32"
            | "mips"
            | "mipsel"
            | "ppc"
            | "ppc64"
            | "s390"
            | "s390x"
            | "x32"
            | "x64"
            | "!arm"
            | "!arm64"
            | "!ia32"
            | "!mips"
            | "!mipsel"
            | "!ppc"
            | "!ppc64"
            | "!s390"
            | "!s390x"
            | "!x32"
            | "!x64",
            string,
        >[];
        dependencies?: Partial<Record<string, string>> & Record<string, string>;
        description?: string;
        devDependencies?: Partial<Record<string, string>> & Record<string, string>;
        directories?: DirectoryLocations;
        engines?: { [key: string]: string | undefined };
        engineStrict?: boolean;
        esnext?:
            | string
            | {
                browser?: string;
                main?: string;
                [moduleName: string]: string
                | undefined;
            };
        exports?: Exports;
        files?: string[];
        flat?: boolean;
        funding?: | string
        | {
            type?: LiteralUnion<
                | "github"
                | "opencollective"
                | "patreon"
                | "individual"
                | "foundation"
                | "corporation",
                string,
            >;
            url: string;
        };
        homepage?: LiteralUnion<".", string>;
        imports?: Imports;
        jspm?: PackageJson;
        keywords?: string[];
        license?: string;
        licenses?: { type?: string; url?: string }[];
        main?: string;
        maintainers?: Person[];
        man?: string | string[];
        module?: string;
        name: string;
        optionalDependencies?: Partial<Record<string, string>> & Record<
            string,
            string,
        >;
        os?: LiteralUnion<
            | "aix"
            | "darwin"
            | "freebsd"
            | "linux"
            | "openbsd"
            | "sunos"
            | "win32"
            | "!aix"
            | "!darwin"
            | "!freebsd"
            | "!linux"
            | "!openbsd"
            | "!sunos"
            | "!win32",
            string,
        >[];
        packageManager?: string;
        peerDependencies?: Partial<Record<string, string>> & Record<
            string,
            string,
        >;
        peerDependenciesMeta?: Partial<Record<string, { optional: true }>>;
        preferGlobal?: boolean;
        private?: boolean;
        publishConfig?: PublishConfig;
        repository?: string | { directory?: string; type: string; url: string };
        resolutions?: Partial<Record<string, string>> & Record<string, string>;
        resolutionsExplained?: Record<string, string>;
        scripts?: Scripts;
        sideEffects?: boolean | string[];
        type?: "module" | "commonjs";
        types?: string;
        typesVersions?: Partial<Record<string, Partial<Record<string, string[]>>>>;
        typings?: string;
        version?: string;
        workspaces?: string[] | WorkspaceConfig;
        [key: string]:
            | (
                (string | number | boolean | JsonObject | JsonValue[] | readonly JsonValue[]) & (string | number | boolean | JsonObject | JsonValue[] | readonly JsonValue[] | undefined)
            )
            | null;
    };
    pkgDirname: string;
    pkgPathName: string;
    run: (options?: CheckPackageApiRunOptions) => Promise<void>;
    runSync: (options?: CheckPackageApiRunOptions) => void;
}

Properties

checkDirectDuplicateDependencies

checkDirectDuplicateDependencies: (
options?: CheckDirectDuplicateDependenciesOptions,
) => CheckPackageApi

Example

.checkDirectDuplicateDependencies({
  invalidOnlyWarnsFor: { '*': 'type-fest' },
})

checkDirectPeerDependencies

checkDirectPeerDependencies: (
options?: CheckDirectPeerDependenciesOptions,
) => CheckPackageApi

Example

.checkDirectPeerDependencies({
  invalidOnlyWarnsFor: ['semver'],
})

checkExactDevVersions

checkExactDevVersions: (options?: CheckExactVersionsOptions) => CheckPackageApi

checkExactVersions

checkExactVersions: (options?: CheckExactVersionsOptions) => CheckPackageApi

checkIdenticalVersions

checkIdenticalVersions: (
    dependencies: {
        dependencies?: Record<string, string[]>;
        devDependencies?: Record<string, string[]>;
        resolutions?: Record<string, string[]>;
    },
) => CheckPackageApi

Check that your package.json dependencies have the exact same version that another dependency also present in your package.json

Example

The react-dom version should match react, so this check will ensure it does

.checkIdenticalVersions({
  dependencies: {
    react: {
      dependencies: ['react-dom'],
      devDependencies: ['react-test-renderer'],
    },
  },
})

checkIdenticalVersionsThanDependency

checkIdenticalVersionsThanDependency: (
    depName: string,
    dependencies: {
        dependencies?: string[];
        devDependencies?: string[];
        resolutions?: string[];
    },
) => CheckPackageApi

Example

Check that your package.json contains the same version of @babel/core than react-scripts, both in resolutions and devDependencies

.checkIdenticalVersionsThanDependency('react-scripts', {
  resolutions: ['@babel/core'],
  devDependencies: ['@babel/core'],
})

checkIdenticalVersionsThanDevDependencyOfDependency

checkIdenticalVersionsThanDevDependencyOfDependency: (
    depName: string,
    dependencies: {
        dependencies?: string[];
        devDependencies?: string[];
        resolutions?: string[];
    },
) => CheckPackageApi

checkMinRangeDependenciesSatisfiesDevDependencies

checkMinRangeDependenciesSatisfiesDevDependencies: () => CheckPackageApi

checkMinRangePeerDependenciesSatisfiesDependencies

checkMinRangePeerDependenciesSatisfiesDependencies: () => CheckPackageApi

checkNoDependencies

checkNoDependencies: (
type?: DependencyTypes,
moveToSuggestion?: DependencyTypes,
) => CheckPackageApi

checkRecommended

checkRecommended: (options?: CheckRecommendedOptions) => CheckPackageApi

checkResolutionsHasExplanation

checkResolutionsHasExplanation: (
checkMessage?: CheckResolutionMessage,
) => CheckPackageApi

checkResolutionsVersionsMatch

checkResolutionsVersionsMatch: () => CheckPackageApi

checkSatisfiesVersions

checkSatisfiesVersions: (
    dependencies: Partial<
        Record<DependencyTypes, Record<DependencyName, string>>,
    >,
) => CheckPackageApi

Check that your package.json dependencies specifically satisfies the range passed in config

Example

.checkSatisfiesVersions({
  devDependencies: {
    eslint: '^8.0.0'
  },
})

checkSatisfiesVersionsBetweenDependencies

checkSatisfiesVersionsBetweenDependencies: (
    config: Record<
        string,
        {
            dependencies?: Record<
                string,
                { dependencies?: string[]; devDependencies?: string[] },
            >;
            devDependencies?: Record<
                string,
                { dependencies?: string[]; devDependencies?: string[] },
            >;
        },
    >,
) => CheckPackageApi

checkSatisfiesVersionsFromDependency

checkSatisfiesVersionsFromDependency: (
    depName: string,
    dependencies: {
        dependencies?: string[];
        devDependencies?: string[];
        resolutions?: string[];
    },
) => CheckPackageApi

Check that your package.json dependencies specifically satisfies the range set in another dependencies

Example

.checkSatisfiesVersionsFromDependency('@pob/eslint-config-typescript', {
  devDependencies: [
    '@typescript-eslint/eslint-plugin',
    '@typescript-eslint/parser',
  ],
})

checkSatisfiesVersionsInDependency

checkSatisfiesVersionsInDependency: (
depName: string,
dependenciesRanges: DependenciesRanges,
) => CheckPackageApi

Check versions in a dependency Also useable to check if a dependency is not present

Example

Checking if @lerna/version has no dependency @nrwl/devkit

.checkSatisfiesVersionsInDependency('@lerna/version', {
  dependencies: {
    '@nrwl/devkit': null,
  },
})

checkSatisfiesVersionsInDevDependenciesOfDependency

checkSatisfiesVersionsInDevDependenciesOfDependency: (
    depName: string,
    dependencies: {
        dependencies?: string[];
        devDependencies?: string[];
        resolutions?: string[];
    },
) => CheckPackageApi

`Internal`getDependencyPackageJson

getDependencyPackageJson: GetDependencyPackageJson

`Internal`isPkgLibrary

isPkgLibrary: boolean

`Internal`parsedPkg

parsedPkg: ParsedPackageJson

`Internal`pkg

pkg: {
    author?: Person;
    bin?: string | Partial<Record<string, string>>;
    browser?: string | Partial<Record<string, string | false>>;
    bugs?: BugsLocation;
    bundledDependencies?: string[];
    bundleDependencies?: string[];
    config?: JsonObject;
    contributors?: Person[];
    cpu?: LiteralUnion<
        | "arm"
        | "arm64"
        | "ia32"
        | "mips"
        | "mipsel"
        | "ppc"
        | "ppc64"
        | "s390"
        | "s390x"
        | "x32"
        | "x64"
        | "!arm"
        | "!arm64"
        | "!ia32"
        | "!mips"
        | "!mipsel"
        | "!ppc"
        | "!ppc64"
        | "!s390"
        | "!s390x"
        | "!x32"
        | "!x64",
        string,
    >[];
    dependencies?: Partial<Record<string, string>> & Record<string, string>;
    description?: string;
    devDependencies?: Partial<Record<string, string>> & Record<string, string>;
    directories?: DirectoryLocations;
    engines?: { [key: string]: string | undefined };
    engineStrict?: boolean;
    esnext?:
        | string
        | {
            browser?: string;
            main?: string;
            [moduleName: string]: string
            | undefined;
        };
    exports?: Exports;
    files?: string[];
    flat?: boolean;
    funding?: | string
    | {
        type?: LiteralUnion<
            | "github"
            | "opencollective"
            | "patreon"
            | "individual"
            | "foundation"
            | "corporation",
            string,
        >;
        url: string;
    };
    homepage?: LiteralUnion<".", string>;
    imports?: Imports;
    jspm?: PackageJson;
    keywords?: string[];
    license?: string;
    licenses?: { type?: string; url?: string }[];
    main?: string;
    maintainers?: Person[];
    man?: string | string[];
    module?: string;
    name: string;
    optionalDependencies?: Partial<Record<string, string>> & Record<
        string,
        string,
    >;
    os?: LiteralUnion<
        | "aix"
        | "darwin"
        | "freebsd"
        | "linux"
        | "openbsd"
        | "sunos"
        | "win32"
        | "!aix"
        | "!darwin"
        | "!freebsd"
        | "!linux"
        | "!openbsd"
        | "!sunos"
        | "!win32",
        string,
    >[];
    packageManager?: string;
    peerDependencies?: Partial<Record<string, string>> & Record<string, string>;
    peerDependenciesMeta?: Partial<Record<string, { optional: true }>>;
    preferGlobal?: boolean;
    private?: boolean;
    publishConfig?: PublishConfig;
    repository?: string | { directory?: string; type: string; url: string };
    resolutions?: Partial<Record<string, string>> & Record<string, string>;
    resolutionsExplained?: Record<string, string>;
    scripts?: Scripts;
    sideEffects?: boolean | string[];
    type?: "module" | "commonjs";
    types?: string;
    typesVersions?: Partial<Record<string, Partial<Record<string, string[]>>>>;
    typings?: string;
    version?: string;
    workspaces?: string[] | WorkspaceConfig;
    [key: string]:
        | (
            (string | number | boolean | JsonObject | JsonValue[] | readonly JsonValue[]) & (string | number | boolean | JsonObject | JsonValue[] | readonly JsonValue[] | undefined)
        )
        | null;
}

Type Declaration

[key: string]:
    | (
        (string | number | boolean | JsonObject | JsonValue[] | readonly JsonValue[]) & (string | number | boolean | JsonObject | JsonValue[] | readonly JsonValue[] | undefined)
    )
    | null
Optionalauthor?: Person
Optionalbin?: string | Partial<Record<string, string>>
The executable files that should be installed into the PATH.
Optionalbrowser?: string | Partial<Record<string, string | false>>
A hint to JavaScript bundlers or component tools when packaging modules for client side use.
Optionalbugs?: BugsLocation
The URL to the package's issue tracker and/or the email address to which issues should be reported.
OptionalbundledDependencies?: string[]
Package names that are bundled when the package is published.
OptionalbundleDependencies?: string[]
Alias of bundledDependencies.
Optionalconfig?: JsonObject
Is used to set configuration parameters used in package scripts that persist across upgrades.
Optionalcontributors?: Person[]
A list of people who contributed to the package.
Optionalcpu?: LiteralUnion<
    | "arm"
    | "arm64"
    | "ia32"
    | "mips"
    | "mipsel"
    | "ppc"
    | "ppc64"
    | "s390"
    | "s390x"
    | "x32"
    | "x64"
    | "!arm"
    | "!arm64"
    | "!ia32"
    | "!mips"
    | "!mipsel"
    | "!ppc"
    | "!ppc64"
    | "!s390"
    | "!s390x"
    | "!x32"
    | "!x64",
    string,
>[]
CPU architectures the module runs on.
Optionaldependencies?: Partial<Record<string, string>> & Record<string, string>
The dependencies of the package.
Optionaldescription?: string
Package description, listed in npm search.
OptionaldevDependencies?: Partial<Record<string, string>> & Record<string, string>
Additional tooling dependencies that are not required for the package to work. Usually test, build, or documentation tooling.
Optionaldirectories?: DirectoryLocations
Indicates the structure of the package.
Optionalengines?: { [key: string]: string | undefined }
Engines that this package runs on.
OptionalengineStrict?: boolean
Deprecated
Optionalesnext?:
    | string
    | {
        browser?: string;
        main?: string;
        [moduleName: string]: string
        | undefined;
    }
A module ID with untranspiled code that is the primary entry point to the program.
Optionalexports?: Exports
Subpath exports to define entry points of the package.

Read more.
Optionalfiles?: string[]
The files included in the package.
Optionalflat?: boolean
If your package only allows one version of a given dependency, and you’d like to enforce the same behavior as yarn install --flat on the command-line, set this to true.

Note that if your package.json contains "flat": true and other packages depend on yours (e.g. you are building a library rather than an app), those other packages will also need "flat": true in their package.json or be installed with yarn install --flat on the command-line.
Optionalfunding?:
    | string
    | {
        type?: LiteralUnion<
            | "github"
            | "opencollective"
            | "patreon"
            | "individual"
            | "foundation"
            | "corporation",
            string,
        >;
        url: string;
    }
Describes and notifies consumers of a package's monetary support information.

Read more.
Optionalhomepage?: LiteralUnion<".", string>
The URL to the package's homepage.
Optionalimports?: Imports
Subpath imports to define internal package import maps that only apply to import specifiers from within the package itself.

Read more.
Optionaljspm?: PackageJson
JSPM configuration.
Optionalkeywords?: string[]
Keywords associated with package, listed in npm search.
Optionallicense?: string
The license for the package.
Optionallicenses?: { type?: string; url?: string }[]
The licenses for the package.
Optionalmain?: string
The module ID that is the primary entry point to the program.
Optionalmaintainers?: Person[]
A list of people who maintain the package.
Optionalman?: string | string[]
Filenames to put in place for the man program to find.
Optionalmodule?: string
An ECMAScript module ID that is the primary entry point to the program.
name: string
The name of the package.
OptionaloptionalDependencies?: Partial<Record<string, string>> & Record<string, string>
Dependencies that are skipped if they fail to install.
Optionalos?: LiteralUnion<
    | "aix"
    | "darwin"
    | "freebsd"
    | "linux"
    | "openbsd"
    | "sunos"
    | "win32"
    | "!aix"
    | "!darwin"
    | "!freebsd"
    | "!linux"
    | "!openbsd"
    | "!sunos"
    | "!win32",
    string,
>[]
Operating systems the module runs on.
OptionalpackageManager?: string
Defines which package manager is expected to be used when working on the current project. It can set to any of the supported package managers, and will ensure that your teams use the exact same package manager versions without having to install anything else than Node.js.

This field is currently experimental and needs to be opted-in; check the Corepack page for details about the procedure.
Example
```
{
	"packageManager": "<package manager name>@<version>"
}
```
OptionalpeerDependencies?: Partial<Record<string, string>> & Record<string, string>
Dependencies that will usually be required by the package user directly or via another dependency.
OptionalpeerDependenciesMeta?: Partial<Record<string, { optional: true }>>
Indicate peer dependencies that are optional.
OptionalpreferGlobal?: boolean
If set to true, a warning will be shown if package is installed locally. Useful if the package is primarily a command-line application that should be installed globally.

Deprecated
Optionalprivate?: boolean
If set to true, then npm will refuse to publish it.
OptionalpublishConfig?: PublishConfig
A set of config values that will be used at publish-time. It's especially handy to set the tag, registry or access, to ensure that a given package is not tagged with 'latest', published to the global public registry or that a scoped module is private by default.
Optionalrepository?: string | { directory?: string; type: string; url: string }
Location for the code repository.
Optionalresolutions?: Partial<Record<string, string>> & Record<string, string>
Selective version resolutions. Allows the definition of custom package versions inside dependencies without manual edits in the yarn.lock file.
OptionalresolutionsExplained?: Record<string, string>
Optionalscripts?: Scripts
Script commands that are run at various times in the lifecycle of the package. The key is the lifecycle event, and the value is the command to run at that point.
OptionalsideEffects?: boolean | string[]
Denote which files in your project are "pure" and therefore safe for Webpack to prune if unused.

Read more.
Optionaltype?: "module" | "commonjs"
Resolution algorithm for importing ".js" files from the package's scope.

Read more.
Optionaltypes?: string
Location of the bundled TypeScript declaration file.
OptionaltypesVersions?: Partial<Record<string, Partial<Record<string, string[]>>>>
Version selection map of TypeScript.
Optionaltypings?: string
Location of the bundled TypeScript declaration file. Alias of types.
Optionalversion?: string
Package version, parseable by node-semver.
Optionalworkspaces?: string[] | WorkspaceConfig
Used to configure npm workspaces / Yarn workspaces.

Workspaces allow you to manage multiple packages within the same repository in such a way that you only need to run your install command once in order to install all of them in a single pass.

Please note that the top-level private property of package.json must be set to true in order to use workspaces.

`Internal`pkgDirname

pkgDirname: string

`Internal`pkgPathName

pkgPathName: string

run

run: (options?: CheckPackageApiRunOptions) => Promise<void>

runSync

runSync: (options?: CheckPackageApiRunOptions) => void

Interface CheckPackageApi

Index

Properties

Properties

checkDirectDuplicateDependencies

Example

checkDirectPeerDependencies

Example

checkExactDevVersions

checkExactVersions

checkIdenticalVersions

Example

checkIdenticalVersionsThanDependency

Example

checkIdenticalVersionsThanDevDependencyOfDependency

checkMinRangeDependenciesSatisfiesDevDependencies

checkMinRangePeerDependenciesSatisfiesDependencies

checkNoDependencies

checkRecommended

checkResolutionsHasExplanation

checkResolutionsVersionsMatch

checkSatisfiesVersions

Example

checkSatisfiesVersionsBetweenDependencies

checkSatisfiesVersionsFromDependency

Example

checkSatisfiesVersionsInDependency

Example

checkSatisfiesVersionsInDevDependenciesOfDependency

InternalgetDependencyPackageJson

InternalisPkgLibrary

InternalparsedPkg

Internalpkg

Type Declaration

[key: string]: | ( (string | number | boolean | JsonObject | JsonValue[] | readonly JsonValue[]) & (string | number | boolean | JsonObject | JsonValue[] | readonly JsonValue[] | undefined) ) | null

Optionalauthor?: Person

Optionalbin?: string | Partial<Record<string, string>>

Optionalbrowser?: string | Partial<Record<string, string | false>>

Optionalbugs?: BugsLocation

OptionalbundledDependencies?: string[]

OptionalbundleDependencies?: string[]

Optionalconfig?: JsonObject

Optionalcontributors?: Person[]

Optionalcpu?: LiteralUnion< | "arm" | "arm64" | "ia32" | "mips" | "mipsel" | "ppc" | "ppc64" | "s390" | "s390x" | "x32" | "x64" | "!arm" | "!arm64" | "!ia32" | "!mips" | "!mipsel" | "!ppc" | "!ppc64" | "!s390" | "!s390x" | "!x32" | "!x64", string,>[]

Optionaldependencies?: Partial<Record<string, string>> & Record<string, string>

Optionaldescription?: string

OptionaldevDependencies?: Partial<Record<string, string>> & Record<string, string>

Optionaldirectories?: DirectoryLocations

Optionalengines?: { [key: string]: string | undefined }

OptionalengineStrict?: boolean

Deprecated

Optionalesnext?: | string | { browser?: string; main?: string; [moduleName: string]: string | undefined; }

Optionalexports?: Exports

Optionalfiles?: string[]

Optionalflat?: boolean

Optionalfunding?: | string | { type?: LiteralUnion< | "github" | "opencollective" | "patreon" | "individual" | "foundation" | "corporation", string, >; url: string; }

Optionalhomepage?: LiteralUnion<".", string>

Optionalimports?: Imports

Optionaljspm?: PackageJson

Optionalkeywords?: string[]

Optionallicense?: string

Optionallicenses?: { type?: string; url?: string }[]

Optionalmain?: string

Optionalmaintainers?: Person[]

Optionalman?: string | string[]

Optionalmodule?: string

name: string

OptionaloptionalDependencies?: Partial<Record<string, string>> & Record<string, string>

Optionalos?: LiteralUnion< | "aix" | "darwin" | "freebsd" | "linux" | "openbsd" | "sunos" | "win32" | "!aix" | "!darwin" | "!freebsd" | "!linux" | "!openbsd" | "!sunos" | "!win32", string,>[]

OptionalpackageManager?: string

Example

OptionalpeerDependencies?: Partial<Record<string, string>> & Record<string, string>

OptionalpeerDependenciesMeta?: Partial<Record<string, { optional: true }>>

OptionalpreferGlobal?: boolean

Deprecated

Optionalprivate?: boolean

OptionalpublishConfig?: PublishConfig

Optionalrepository?: string | { directory?: string; type: string; url: string }

Optionalresolutions?: Partial<Record<string, string>> & Record<string, string>

OptionalresolutionsExplained?: Record<string, string>

`Internal`getDependencyPackageJson

`Internal`isPkgLibrary

`Internal`parsedPkg

`Internal`pkg

[key: string]:
| (
(string | number | boolean | JsonObject | JsonValue[] | readonly JsonValue[]) & (string | number | boolean | JsonObject | JsonValue[] | readonly JsonValue[] | undefined)
)
| null

`Optional`author?: Person

`Optional`bin?: string | Partial<Record<string, string>>

`Optional`browser?: string | Partial<Record<string, string | false>>

`Optional`bugs?: BugsLocation

`Optional`bundledDependencies?: string[]

`Optional`bundleDependencies?: string[]

`Optional`config?: JsonObject

`Optional`contributors?: Person[]

`Optional`cpu?: LiteralUnion<
| "arm"
| "arm64"
| "ia32"
| "mips"
| "mipsel"
| "ppc"
| "ppc64"
| "s390"
| "s390x"
| "x32"
| "x64"
| "!arm"
| "!arm64"
| "!ia32"
| "!mips"
| "!mipsel"
| "!ppc"
| "!ppc64"
| "!s390"
| "!s390x"
| "!x32"
| "!x64",
string,
>[]

`Optional`dependencies?: Partial<Record<string, string>> & Record<string, string>

`Optional`description?: string

`Optional`devDependencies?: Partial<Record<string, string>> & Record<string, string>

`Optional`directories?: DirectoryLocations

`Optional`engines?: { [key: string]: string | undefined }

`Optional`engineStrict?: boolean

`Optional`esnext?:
| string
| {
browser?: string;
main?: string;
[moduleName: string]: string
| undefined;
}

`Optional`exports?: Exports

`Optional`files?: string[]

`Optional`flat?: boolean

`Optional`funding?:
| string
| {
type?: LiteralUnion<
| "github"
| "opencollective"
| "patreon"
| "individual"
| "foundation"
| "corporation",
string,
>;
url: string;
}

`Optional`homepage?: LiteralUnion<".", string>

`Optional`imports?: Imports

`Optional`jspm?: PackageJson

`Optional`keywords?: string[]

`Optional`license?: string

`Optional`licenses?: { type?: string; url?: string }[]

`Optional`main?: string

`Optional`maintainers?: Person[]

`Optional`man?: string | string[]

`Optional`module?: string

`Optional`optionalDependencies?: Partial<Record<string, string>> & Record<string, string>

`Optional`os?: LiteralUnion<
| "aix"
| "darwin"
| "freebsd"
| "linux"
| "openbsd"
| "sunos"
| "win32"
| "!aix"
| "!darwin"
| "!freebsd"
| "!linux"
| "!openbsd"
| "!sunos"
| "!win32",
string,
>[]

`Optional`packageManager?: string

`Optional`peerDependencies?: Partial<Record<string, string>> & Record<string, string>

`Optional`peerDependenciesMeta?: Partial<Record<string, { optional: true }>>

`Optional`preferGlobal?: boolean

`Optional`private?: boolean

`Optional`publishConfig?: PublishConfig

`Optional`repository?: string | { directory?: string; type: string; url: string }

`Optional`resolutions?: Partial<Record<string, string>> & Record<string, string>

`Optional`resolutionsExplained?: Record<string, string>

`Optional`scripts?: Scripts

`Optional`sideEffects?: boolean | string[]

`Optional`type?: "module" | "commonjs"

`Optional`types?: string

`Optional`typesVersions?: Partial<Record<string, Partial<Record<string, string[]>>>>

`Optional`typings?: string

`Optional`version?: string

`Optional`workspaces?: string[] | WorkspaceConfig

`Internal`pkgDirname

`Internal`pkgPathName