Class PackageEntryPoint

Information on package entry point.

Hierarchy

PackageEntryTargets
- PackageEntryPoint

Index

Constructors

Accessors

entryPoint packageInfo path

Methods

findConditional findJs findTargets isPattern

Constructors

constructor

new PackageEntryPoint(packageInfo, path, targets): PackageEntryPoint
Constructs entry point.
Parameters
- packageInfo: PackageInfo
  
  Host package info.
- path: PackagePath
  
  Exported path.
- targets: readonly Target[]
  
  Array of exported targets. May contain different targets for different conditions.
Returns PackageEntryPoint
Overrides PackageEntryTargets.constructor
- Defined in package/package-entry-point.ts:25

Accessors

entryPoint

get entryPoint(): this
The entry point itself.

Returns this
Overrides PackageEntryTargets.entryPoint
- Defined in package/package-entry-point.ts:59

packageInfo

get packageInfo(): PackageInfo
Host package info.

Returns PackageInfo
- Defined in package/package-entry-point.ts:52

path

get path(): PackagePath
Exported path or pattern.

Returns PackagePath
- Defined in package/package-entry-point.ts:66

Methods

findConditional

findConditional(...conditions): undefined | `./${string}`
Searches for path or pattern matching all provided conditions.
Parameters
- Rest ...conditions: string[]
  
  Required export conditions. When missing, searches for default one.
Returns undefined | `./${string}`
Matching path or pattern, or undefined when not found.
Overrides PackageEntryTargets.findConditional
- Defined in package/package-entry-point.ts:128

findJs

findJs(type, ...conditions): undefined | `./${string}`
Searches for exported JavaScript file to import into another module matching all provided condition.

Target selection depends on consumer's package type.
Parameters
- type: undefined | null | "module" | "commonjs"
  
  Consumer package type.
- Rest ...conditions: string[]
  
  Additional export conditions.
Returns undefined | `./${string}`
Matching JavaScript file path, or undefined when not found.
Inherited from PackageEntryTargets.findJs
- Defined in package/package-entry-targets.ts:36

findTargets

findTargets(path): undefined | PackageEntryTargets
Searches for targets exported by this entry point for the given path.
Parameters
- path: PackagePath
  
  Export path to check.
Returns undefined | PackageEntryTargets
Either exported targets, or undefined if the path is not exported.
- Defined in package/package-entry-point.ts:88

isPattern

isPattern(): boolean
Checks whether this is a subpath pattern matching multiple entry points.

Returns boolean
true if path contains *, or false otherwise.
- Defined in package/package-entry-point.ts:77

Generated using TypeDoc