Skip to main content

PackageDescriptor

@webda/compiler

Interface: PackageDescriptor

Defined in: compiler/src/definition.ts:756

Some package exists but seems pretty big for this https://classic.yarnpkg.com/en/docs/package-json

Properties​

author?​

optional author?: PackageDescriptorAuthor

Defined in: compiler/src/definition.ts:792

The author of the package.

bin?​

optional bin?: string | {[key: string]: string; }

Defined in: compiler/src/definition.ts:808

The executable files for the package.

bugs?​

optional bugs?: string

Defined in: compiler/src/definition.ts:784

The URL to the package's issue tracker.

bundledDependencies?​

optional bundledDependencies?: string[]

Defined in: compiler/src/definition.ts:856

The bundled dependencies of the package.

config?​

optional config?: any

Defined in: compiler/src/definition.ts:828

Configuration options for the package.

contributors?​

optional contributors?: string[] | PackageDescriptorAuthor[]

Defined in: compiler/src/definition.ts:796

The contributors to the package.

cpu?​

optional cpu?: string[]

Defined in: compiler/src/definition.ts:876

The CPU architectures that the package is compatible with.

dependencies?​

optional dependencies?: object

Defined in: compiler/src/definition.ts:832

The dependencies of the package.

Index Signature​

[key: string]: string

description?​

optional description?: string

Defined in: compiler/src/definition.ts:768

A brief description of the package.

devDependencies?​

optional devDependencies?: object

Defined in: compiler/src/definition.ts:836

The development dependencies of the package.

Index Signature​

[key: string]: string

directories?​

optional directories?: object

Defined in: compiler/src/definition.ts:820

The directories in the package.

Index Signature​

[key: string]: string

engines?​

optional engines?: object

Defined in: compiler/src/definition.ts:868

The engines that the package is compatible with.

Index Signature​

[key: string]: string

files?​

optional files?: string[]

Defined in: compiler/src/definition.ts:800

The files included in the package.

flat?​

optional flat?: boolean

Defined in: compiler/src/definition.ts:860

If true, the package will be installed with a flat node_modules structure.

homepage?​

optional homepage?: string

Defined in: compiler/src/definition.ts:780

The homepage URL for the package.

keywords?​

optional keywords?: string[]

Defined in: compiler/src/definition.ts:772

Keywords that describe the package.

license?​

optional license?: string | { name: string; }

Defined in: compiler/src/definition.ts:776

The license for the package.

main?​

optional main?: string

Defined in: compiler/src/definition.ts:804

The entry point to the package.

man?​

optional man?: string | string[]

Defined in: compiler/src/definition.ts:816

The manual pages for the package.

name?​

optional name?: string

Defined in: compiler/src/definition.ts:760

The name of the package.

optionalDependencies?​

optional optionalDependencies?: object

Defined in: compiler/src/definition.ts:852

The optional dependencies of the package.

Index Signature​

[key: string]: string

os?​

optional os?: string[]

Defined in: compiler/src/definition.ts:872

The operating systems that the package is compatible with.

peerDependencies?​

optional peerDependencies?: object

Defined in: compiler/src/definition.ts:840

The peer dependencies of the package.

Index Signature​

[key: string]: string

peerDependenciesMeta?​

optional peerDependenciesMeta?: object

Defined in: compiler/src/definition.ts:844

Metadata for peer dependencies.

Index Signature​

[key: string]: object

private?​

optional private?: boolean

Defined in: compiler/src/definition.ts:880

If true, the package is private and cannot be published.

publishConfig?​

optional publishConfig?: any

Defined in: compiler/src/definition.ts:884

Configuration for publishing the package.

repository?​

optional repository?: string

Defined in: compiler/src/definition.ts:788

The URL to the package's repository.

resolutions?​

optional resolutions?: object

Defined in: compiler/src/definition.ts:864

Resolutions for dependencies.

Index Signature​

[key: string]: string

scripts?​

optional scripts?: object

Defined in: compiler/src/definition.ts:824

The scripts that can be run for the package.

Index Signature​

[key: string]: string

termsOfService?​

optional termsOfService?: string

Defined in: compiler/src/definition.ts:892

The terms of service for the package.

title?​

optional title?: string

Defined in: compiler/src/definition.ts:896

The title of the package.

version?​

optional version?: string

Defined in: compiler/src/definition.ts:764

The version of the package.

webda?​

optional webda?: Partial<WebdaPackageDescriptor>

Defined in: compiler/src/definition.ts:888

Webda specific metadata for the package.