Interface PackageJsonStandard

Type for npm's package.json file. Containing standard npm properties.

interface PackageJsonStandard {
    author?: Person;
    bin?: string | Partial<Record<string, string>>;
    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>>;
    description?: string;
    devDependencies?: Partial<Record<string, string>>;
    directories?: DirectoryLocations;
    engines?: { [key: string]: undefined | string };
    engineStrict?: boolean;
    exports?: Exports;
    files?: string[];
    funding?:
        | string
        | {
            type?: LiteralUnion<
                | "github"
                | "opencollective"
                | "patreon"
                | "individual"
                | "foundation"
                | "corporation",
                string,
            >;
            url: string;
        };
    homepage?: LiteralUnion<".", string>;
    imports?: Imports;
    keywords?: string[];
    license?: string;
    licenses?: { type?: string; url?: string }[];
    main?: string;
    maintainers?: Person[];
    man?: string | string[];
    name?: string;
    optionalDependencies?: Partial<Record<string, string>>;
    os?: LiteralUnion<
        | "aix"
        | "darwin"
        | "freebsd"
        | "linux"
        | "openbsd"
        | "sunos"
        | "win32"
        | "!aix"
        | "!darwin"
        | "!freebsd"
        | "!linux"
        | "!openbsd"
        | "!sunos"
        | "!win32",
        string,
    >[];
    peerDependencies?: Partial<Record<string, string>>;
    peerDependenciesMeta?: Partial<Record<string, { optional: true }>>;
    preferGlobal?: boolean;
    private?: boolean;
    publishConfig?: PublishConfig;
    repository?: string | { directory?: string; type: string; url: string };
    scripts?: Scripts;
    type?: "module" | "commonjs";
    version?: string;
    workspaces?: string[] | WorkspaceConfig;
}

Properties

author? bin? bugs? bundledDependencies? bundleDependencies? config? contributors? cpu? dependencies? description? devDependencies? directories? engines? engineStrict? exports? files? funding? homepage? imports? keywords? license? licenses? main? maintainers? man? name? optionalDependencies? os? peerDependencies? peerDependenciesMeta? preferGlobal? private? publishConfig? repository? scripts? type? version? workspaces?

Properties

Optionalauthor

author?: Person

Optionalbin

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

The executable files that should be installed into the PATH.

Optionalbugs

bugs?: BugsLocation

The URL to the package's issue tracker and/or the email address to which issues should be reported.

OptionalbundledDependencies

bundledDependencies?: string[]

Package names that are bundled when the package is published.

OptionalbundleDependencies

bundleDependencies?: string[]

Alias of bundledDependencies.

Optionalconfig

config?: JsonObject

Is used to set configuration parameters used in package scripts that persist across upgrades.

Optionalcontributors

contributors?: Person[]

A list of people who contributed to the package.

Optionalcpu

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,
>[]

CPU architectures the module runs on.

Optionaldependencies

dependencies?: Partial<Record<string, string>>

The dependencies of the package.

Optionaldescription

description?: string

Package description, listed in npm search.

OptionaldevDependencies

devDependencies?: Partial<Record<string, string>>

Additional tooling dependencies that are not required for the package to work. Usually test, build, or documentation tooling.

Optionaldirectories

directories?: DirectoryLocations

Indicates the structure of the package.

Optionalengines

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

Engines that this package runs on.

OptionalengineStrict

engineStrict?: boolean

Deprecated

Optionalexports

exports?: Exports

Subpath exports to define entry points of the package.

Read more.

Optionalfiles

files?: string[]

The files included in the package.

Optionalfunding

funding?:
    | 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.

Type declaration

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

      The type of funding.

    • url: string

      The URL to the funding page.

Optionalhomepage

homepage?: LiteralUnion<".", string>

The URL to the package's homepage.

Optionalimports

imports?: Imports

Subpath imports to define internal package import maps that only apply to import specifiers from within the package itself.

Read more.

Optionalkeywords

keywords?: string[]

Keywords associated with package, listed in npm search.

Optionallicense

license?: string

The license for the package.

Optionallicenses

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

The licenses for the package.

Optionalmain

main?: string

The module ID that is the primary entry point to the program.

Optionalmaintainers

maintainers?: Person[]

A list of people who maintain the package.

Optionalman

man?: string | string[]

Filenames to put in place for the man program to find.

Optionalname

name?: string

The name of the package.

OptionaloptionalDependencies

optionalDependencies?: Partial<Record<string, string>>

Dependencies that are skipped if they fail to install.

Optionalos

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

Operating systems the module runs on.

OptionalpeerDependencies

peerDependencies?: Partial<Record<string, string>>

Dependencies that will usually be required by the package user directly or via another dependency.

OptionalpeerDependenciesMeta

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

Indicate peer dependencies that are optional.

OptionalpreferGlobal

preferGlobal?: 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

private?: boolean

If set to true, then npm will refuse to publish it.

OptionalpublishConfig

publishConfig?: 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

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

Location for the code repository.

Type declaration

  • string
  • { directory?: string; type: string; url: string }
    • Optionaldirectory?: string

      Relative path to package.json if it is placed in non-root directory (for example if it is part of a monorepo).

      Read more.

    • type: string
    • url: string

Optionalscripts

scripts?: 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.

Optionaltype

type?: "module" | "commonjs"

Resolution algorithm for importing ".js" files from the package's scope.

Read more.

Optionalversion

version?: string

Package version, parseable by node-semver.

Optionalworkspaces

workspaces?: 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.

Settings

Member Visibility

On This Page

Properties