Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Project

Hierarchy

  • Project

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

accessibleLocators

accessibleLocators: Set<LocatorHash> = new Set()

conditionalLocators

conditionalLocators: Set<LocatorHash> = new Set()

configuration

configuration: Configuration

cwd

cwd: PortablePath

disabledLocators

disabledLocators: Set<LocatorHash> = new Set()

installStateChecksum

installStateChecksum: string | null = null

linkersCustomData

linkersCustomData: Map<string, unknown> = new Map()

Contains whatever data the linkers (cf Linker.ts) want to persist from an install to another.

lockFileChecksum

lockFileChecksum: string | null = null

Those checksums are used to detect whether the relevant files actually changed since we last read them (to skip part of their generation).

lockfileNeedsRefresh

lockfileNeedsRefresh: boolean = false

If true, the data contained within originalPackages are from a different lockfile version and need to be refreshed.

optionalBuilds

optionalBuilds: Set<LocatorHash> = new Set()

originalPackages

originalPackages: Map<LocatorHash, Package> = new Map()

peerRequirements

peerRequirements: Map<string, PeerRequirement> = new Map()

Populated by the resolveEverything method. Not stored inside the install state.

The map keys are 6 hexadecimal characters except the first one, always p.

The map keys are 6 hexadecimal characters except the first one, always p.

resolutionAliases

resolutionAliases: Map<DescriptorHash, DescriptorHash> = new Map()

Is meant to be populated by the consumer. Should the descriptor referenced by the key be requested, the descriptor referenced in the value will be resolved instead. The resolved data will then be used as final resolution for the initial descriptor.

Note that the lockfile will contain the second descriptor but not the first one (meaning that if you remove the alias during a subsequent install, it'll be lost and the real package will be resolved / installed).

Note that the lockfile will contain the second descriptor but not the first one (meaning that if you remove the alias during a subsequent install, it'll be lost and the real package will be resolved / installed).

storedBuildState

storedBuildState: Map<LocatorHash, string> = new Map()

storedChecksums

storedChecksums: Map<LocatorHash, string> = new Map()

storedDescriptors

storedDescriptors: Map<DescriptorHash, Descriptor> = new Map()

storedPackages

storedPackages: Map<LocatorHash, Package> = new Map()

storedResolutions

storedResolutions: Map<DescriptorHash, LocatorHash> = new Map()

workspaces

workspaces: Array<Workspace> = []

workspacesByCwd

workspacesByCwd: Map<PortablePath, Workspace> = new Map()

workspacesByIdent

workspacesByIdent: Map<IdentHash, Workspace> = new Map()

Accessors

topLevelWorkspace

Methods

Private addWorkspace

applyLightResolution

  • applyLightResolution(): Promise<void>

cacheCleanup

  • cacheCleanup(__namedParameters: object): Promise<void>

Private deleteDescriptor

Private deleteLocator

fetchEverything

  • fetchEverything(__namedParameters: object): Promise<void>

findLocatorForLocation

  • findLocatorForLocation(cwd: PortablePath, __namedParameters?: object): Promise<null | Locator>

forgetResolution

  • forgetResolution(descriptor: Descriptor): void
  • forgetResolution(locator: Locator): void

forgetTransientResolutions

  • forgetTransientResolutions(): void

forgetVirtualResolutions

  • forgetVirtualResolutions(): void

generateLockfile

  • generateLockfile(): string

getDependencyMeta

getWorkspaceByCwd

getWorkspaceByDescriptor

getWorkspaceByFilePath

getWorkspaceByIdent

getWorkspaceByLocator

install

linkEverything

  • linkEverything(__namedParameters: object): Promise<void>

loadUserConfig

  • loadUserConfig(): Promise<any>

persist

  • persist(): Promise<void>

persistInstallStateFile

  • persistInstallStateFile(): Promise<void>

persistLockfile

  • persistLockfile(): Promise<void>

preparePackage

  • preparePackage(originalPkg: Package, __namedParameters: object): Promise<Package>

resolveEverything

  • resolveEverything(opts: Pick<InstallOptions, "report" | "resolver" | "checkResolutions" | "mode"> & object | object): Promise<void>

restoreInstallState

  • restoreInstallState(__namedParameters?: object): Promise<void>

Private setupResolutions

  • setupResolutions(): Promise<void>

Private setupWorkspaces

  • setupWorkspaces(): Promise<void>

tryWorkspaceByCwd

tryWorkspaceByDescriptor

tryWorkspaceByFilePath

tryWorkspaceByIdent

tryWorkspaceByLocator

Static find

Generated using TypeDoc