Skip to main content

Class: Pkg

@pvm/core.Pkg

Hierarchy

Constructors

constructor

• new Pkg(pkgPath, manifest, opts?)

Parameters

NameType
pkgPathstring
manifestPkgMeta
optsPkgCreateOpts

Defined in

packages/pvm-core/lib/pkg.ts:82

Properties

_config

• Private Readonly _config: Config

Defined in

packages/pvm-core/lib/pkg.ts:79


_cwd

• _cwd: string

Defined in

packages/pvm-core/lib/pkg.ts:78


_ref

• Protected _ref: undefined | string

Defined in

packages/pvm-core/lib/pkg.ts:80


indent

• indent: number

Defined in

packages/pvm-core/lib/pkg.ts:72


meta

• meta: PkgMeta

Defined in

packages/pvm-core/lib/pkg.ts:73


name

• Readonly name: string

Defined in

packages/pvm-core/lib/pkg.ts:76


path

• path: string

Defined in

packages/pvm-core/lib/pkg.ts:74


shortName

• Readonly shortName: string

Defined in

packages/pvm-core/lib/pkg.ts:77


sourcePath

• sourcePath: string

Defined in

packages/pvm-core/lib/pkg.ts:75

Accessors

absPath

• get absPath(): string

Returns

string

Defined in

packages/pvm-core/lib/pkg.ts:225


allOwnDeps

• get allOwnDeps(): PkgDeps

Returns

PkgDeps

Defined in

packages/pvm-core/lib/pkg.ts:272


deps

• get deps(): PkgDeps

Returns

PkgDeps

Defined in

packages/pvm-core/lib/pkg.ts:259


isMonorepo

• get isMonorepo(): boolean

Returns

boolean

Defined in

packages/pvm-core/lib/pkg.ts:235


isRoot

• get isRoot(): boolean

Returns

boolean

Defined in

packages/pvm-core/lib/pkg.ts:220


manifestPath

• get manifestPath(): string

Returns

string

Defined in

packages/pvm-core/lib/pkg.ts:230


publishPath

• get publishPath(): string

Returns

string

Defined in

packages/pvm-core/lib/pkg.ts:194


publishRegistry

• get publishRegistry(): undefined | string

Returns

undefined | string

Defined in

packages/pvm-core/lib/pkg.ts:215


pvmConfig

• get pvmConfig(): Config

Returns

Config

Defined in

packages/pvm-core/lib/pkg.ts:109


ref

• get ref(): undefined | string

Returns

undefined | string

Defined in

packages/pvm-core/lib/pkg.ts:113


strictVersion

• get strictVersion(): undefined | string

Returns

undefined | string

Defined in

packages/pvm-core/lib/pkg.ts:182


usingVersionFromSemverTagItself

• get usingVersionFromSemverTagItself(): boolean

Returns

boolean

Defined in

packages/pvm-core/lib/pkg.ts:240


version

• get version(): string

Returns

string

Defined in

packages/pvm-core/lib/pkg.ts:177

Methods

applyMeta

â–¸ applyMeta(newMeta): AppliedPkg

Parameters

NameType
newMetaPkgAppliedMeta

Returns

AppliedPkg

Defined in

packages/pvm-core/lib/pkg.ts:297


applyNewDeps

â–¸ applyNewDeps(newDeps, newMeta?): AppliedPkg

Parameters

NameType
newDepsMap<string, string>
newMetaundefined | PkgAppliedMeta

Returns

AppliedPkg

Defined in

packages/pvm-core/lib/pkg.ts:328


applyVersion

â–¸ applyVersion(newVersion, newDeps?): AppliedPkg

Parameters

NameType
newVersionstring
newDeps?Map<string, string>

Returns

AppliedPkg

Defined in

packages/pvm-core/lib/pkg.ts:335


getAppliedMeta

â–¸ getAppliedMeta(): PkgAppliedMeta

Returns

PkgAppliedMeta

Defined in

packages/pvm-core/lib/pkg.ts:306


getCwd

â–¸ getCwd(): string

Returns

string

Defined in

packages/pvm-core/lib/pkg.ts:105


getDepKeys

â–¸ getDepKeys(pkgName): string[]

Parameters

NameType
pkgNamestring

Returns

string[]

Defined in

packages/pvm-core/lib/pkg.ts:318


getVersion

â–¸ getVersion<F>(fallbackVersion?): string | F

Type parameters

NameType
Fextends undefined | string``undefined

Parameters

NameType
fallbackVersionF

Returns

string | F

Defined in

packages/pvm-core/lib/pkg.ts:117


isAllowedForPublishing

â–¸ isAllowedForPublishing(): boolean

Returns

boolean

Defined in

packages/pvm-core/lib/pkg.ts:347


isMetaEqualsTo

â–¸ isMetaEqualsTo(pkg): boolean

Parameters

NameType
pkgPkg

Returns

boolean

Defined in

packages/pvm-core/lib/pkg.ts:343


resetLazyForVersion

â–¸ resetLazyForVersion(): void

Returns

void

Defined in

packages/pvm-core/lib/pkg.ts:186


save

â–¸ save(): void

Returns

void

Defined in

packages/pvm-core/lib/pkg.ts:292


stringify

â–¸ stringify(): string

Returns

string

Defined in

packages/pvm-core/lib/pkg.ts:288


toApplied

â–¸ toApplied(): AppliedPkg

Returns

AppliedPkg

Defined in

packages/pvm-core/lib/pkg.ts:313


toJSON

â–¸ toJSON(): Omit<Pkg, "_config"> & { version: string }

Returns

Omit<Pkg, "_config"> & { version: string }

Defined in

packages/pvm-core/lib/pkg.ts:352