Skip to content

RootPackage.md

Latest commit

 

History

History
61 lines (32 loc) · 1.29 KB

RootPackage.md

File metadata and controls

61 lines (32 loc) · 1.29 KB

@-xun/project

@-xun/project / src / RootPackage

Type Alias: RootPackage<Json>

RootPackage<Json> = object

Defined in: packages/types/dist/packages/types/src/index.d.ts:16

An object representing the root or "top-level" package in a monorepo or polyrepo project.

Type Parameters

Json

Json extends PackageJson | XPackageJson = XPackageJson

Properties

attributes

attributes: { [key in ProjectAttribute]?: boolean }

Defined in: packages/types/dist/packages/types/src/index.d.ts:28

A collection of ProjectAttribute flags describing the project.

json

json: Json

Defined in: packages/types/dist/packages/types/src/index.d.ts:24

The contents of the root package.json file.

projectMetadata

projectMetadata: ProjectMetadata<Json>

Defined in: packages/types/dist/packages/types/src/index.d.ts:33

A link back to the ProjectMetadata instance containing this package.

root

root: AbsolutePath

Defined in: packages/types/dist/packages/types/src/index.d.ts:20

The absolute path to the root directory of the entire project.