Interface PackageJson

Intended to represent normalized data structures based on PackageJson spec and explained by PackageJson description. Normalization should be done downstream, for example via normalize-package-data.

interface PackageJson {
    author?: string | {
        email?: string;
        name?: string;
    };
    bugs?: string | {
        url?: string;
    };
    description?: string;
    homepage?: string;
    license?: string;
    licenses?: {
        type?: string;
        url?: string;
    }[];
    name?: string;
    repository?: string | {
        directory?: string;
        url?: string;
    };
    version?: string;
}

Properties

author? bugs? description? homepage? license? licenses? name? repository? version?

Properties

Optional author

author?: string | {
    email?: string;
    name?: string;
}

Type declaration

  • Optional email?: string
  • Optional name?: string

Optional bugs

bugs?: string | {
    url?: string;
}

Type declaration

  • Optional url?: string

Optional description

description?: string

Optional homepage

homepage?: string

Optional license

license?: string

Optional licenses

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

Type declaration

  • Optional type?: string
  • Optional url?: string

Optional name

name?: string

Optional repository

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

Type declaration

  • Optional directory?: string
  • Optional url?: string

Optional version

version?: string

Settings

Member Visibility

Theme

On This Page

authorbugsdescriptionhomepagelicenselicensesnamerepositoryversion