Interface PackageJson

An interface that represents a package.json

interface PackageJson {
    author?: string;
    dependencies?: Record<string, string>;
    devDependencies?: Record<string, string>;
    name?: string;
    oclif?: { plugins?: string[] };
    overrides?: Record<string, string>;
    peerDependencies?: Record<string, string>;
    prettier?: string;
    private?: boolean;
    resolutions?: Record<string, string>;
    scripts?: Record<string, string>;
    version?: string;
    workspaces?: string[];
}

Properties

author? dependencies? devDependencies? name? oclif? overrides? peerDependencies? prettier? private? resolutions? scripts? version? workspaces?

Properties

Optionalauthor

author?: string

The author attribute of the package.json

Optionaldependencies

dependencies?: Record<string, string>

The dependencies attribute of the package.json

OptionaldevDependencies

devDependencies?: Record<string, string>

The devDependencies attribute of the package.json

Optionalname

name?: string

The name attribute of the package.json

Optionaloclif

oclif?: { plugins?: string[] }

The optional oclif settings attribute of the package.json

Optionaloverrides

overrides?: Record<string, string>

The overrides attribute of the package.json. Only useful when using npm o npmn as package managers

OptionalpeerDependencies

peerDependencies?: Record<string, string>

The peerDependencies attribute of the package.json

Optionalprettier

prettier?: string

The prettier attribute of the package.json

Optionalprivate

private?: boolean

The private attribute of the package.json. https://docs.npmjs.com/cli/v9/configuring-npm/package-json#private

Optionalresolutions

resolutions?: Record<string, string>

The resolutions attribute of the package.json. Only useful when using yarn as package manager

Optionalscripts

scripts?: Record<string, string>

The scripts attribute of the package.json

Optionalversion

version?: string

The version attribute of the package.json

Optionalworkspaces

workspaces?: string[]

The workspaces attribute of the package.json

Settings

Member Visibility

On This Page

Properties