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;
        type?: string;
        url?: string;
    };
    version?: string;
}

Properties

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

Properties

Optionalauthor

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

Optionalbugs

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

Optionaldescription

description?: string

Optionalhomepage

homepage?: string

Optionallicense

license?: string

Optionallicenses

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

Optionalname

name?: string

Optionalrepository

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

Optionalversion

version?: string

Settings

Member Visibility

On This Page

Properties