Class Package

A package as the sources describe it, accumulated with addInfo/mergeInPlace: only those may change it, everything else reads. Its three version views run from the rawest to the most concrete:

versionConstraints: what each source declared, unmerged.
derivedRange: their intersection, whether or not a version can satisfy it (see hasSatisfiableVersion, and inferredRange on the dependencies context for the range that is only handed out once it is).
resolvedVersion: the one concrete version the exports were read from.

Index

Constructors

Properties

Accessors

dependencies derivedRange effectiveRange namespaceInfo resolvedVersion type versionConstraints

Methods

fromConstants functionIdentifier parsePkgVersionRange addInfo has hasSatisfiableVersion mergeInPlace s3For

Constructors

constructor

new Package(info: { name: string } & PackageOptions): Package
Parameters
- info: { name: string } & PackageOptions
Returns Package
- Defined in src/project/plugins/package-version-plugins/package.ts:66

Properties

`Readonly`name

name: string

Accessors

dependencies

get dependencies(): readonly Package[] | undefined
Returns readonly Package[] | undefined
- Defined in src/project/plugins/package-version-plugins/package.ts:44

derivedRange

get derivedRange(): Range | undefined
Returns Range | undefined
- Defined in src/project/plugins/package-version-plugins/package.ts:56

effectiveRange

get effectiveRange(): Range | undefined
derivedRange if a source declared one, else the resolvedVersion the exports were read from.

Returns Range | undefined
- Defined in src/project/plugins/package-version-plugins/package.ts:62

namespaceInfo

get namespaceInfo(): NamespaceInfo | undefined
Returns NamespaceInfo | undefined
- Defined in src/project/plugins/package-version-plugins/package.ts:47

resolvedVersion

get resolvedVersion(): string | undefined
Returns string | undefined
- Defined in src/project/plugins/package-version-plugins/package.ts:50

type

get type(): PackageType | undefined
Returns PackageType | undefined
- Defined in src/project/plugins/package-version-plugins/package.ts:41

versionConstraints

get versionConstraints(): readonly Range[]
Returns readonly Range[]
- Defined in src/project/plugins/package-version-plugins/package.ts:53

Methods

`Static`fromConstants

fromConstants(name: string, namespace: string, callable: string[]): Package
Builds a package from a raw NAMESPACE body and its list of callable exports.
Parameters
- name: string
- namespace: string
- callable: string[]
Returns Package
- Defined in src/project/plugins/package-version-plugins/package.ts:72

`Static`functionIdentifier

functionIdentifier(dependency: string, func: string): string
Parameters
- dependency: string
- func: string
Returns string
- Defined in src/project/plugins/package-version-plugins/package.ts:152

`Static`parsePkgVersionRange

parsePkgVersionRange(constraint?: string, version?: string): Range | undefined
Parameters
- Optionalconstraint: string
- Optionalversion: string
Returns Range | undefined
- Defined in src/project/plugins/package-version-plugins/package.ts:144

addInfo

addInfo(__namedParameters: PackageOptions): void
Parameters
- __namedParameters: PackageOptions
Returns void
- Defined in src/project/plugins/package-version-plugins/package.ts:121

has

has(name: string, className?: string): boolean
Parameters
- name: string
- OptionalclassName: string
Returns boolean
- Defined in src/project/plugins/package-version-plugins/package.ts:79

hasSatisfiableVersion

hasSatisfiableVersion(): boolean
Whether some concrete version can satisfy every recorded constraint at once.

Returns boolean
- Defined in src/project/plugins/package-version-plugins/package.ts:139

mergeInPlace

mergeInPlace(other: Package): void
Parameters
- other: Package
Returns void
- Defined in src/project/plugins/package-version-plugins/package.ts:110

s3For

s3For(generic: string): string[]
Parameters
- generic: string
Returns string[]
- Defined in src/project/plugins/package-version-plugins/package.ts:106