Workspace

Index

Constructors

• constructor

Properties

• anchoredDescriptor
• anchoredLocator
• cwd
• manifest
• project
• relativeCwd
• workspacesCwds

Accessors

• anchoredPackage

Methods

• accepts
• computeCandidateName
• getRecursiveWorkspaceChildren
• getRecursiveWorkspaceDependencies
• getRecursiveWorkspaceDependents
• persistManifest
• setup

Constructors

constructor

• new Workspace(workspaceCwd: PortablePath, __namedParameters: { project: Project }): Workspace

• Parameters

  • workspaceCwd: PortablePath

  • __namedParameters: { project: Project }

  Returns Workspace

Properties

publicreadonlyanchoredDescriptor

anchoredDescriptor: Descriptor

publicreadonlyanchoredLocator

anchoredLocator: Locator

publicreadonlycwd

cwd: PortablePath

publicmanifest

manifest: Manifest

publicreadonlyproject

project: Project

publicreadonlyrelativeCwd

relativeCwd: PortablePath

publicreadonlyworkspacesCwds

workspacesCwds: Set<PortablePath> = ...

Accessors

anchoredPackage

• get anchoredPackage(): Package

• Returns Package

Methods

accepts

• accepts(range: string): boolean

• Parameters

  • range: string

  Returns boolean

computeCandidateName

• computeCandidateName(): string

• Returns string

getRecursiveWorkspaceChildren

• getRecursiveWorkspaceChildren(): Workspace[]

• Retrieves all the child workspaces of a given root workspace recursively

  ---

  Returns Workspace[]

  all the child workspaces

getRecursiveWorkspaceDependencies

• getRecursiveWorkspaceDependencies(__namedParameters?: { dependencies?: HardDependencies[] }): Set<Workspace>

• Find workspaces marked as dependencies/devDependencies of the current workspace recursively.

  ---

  Parameters

  • __namedParameters: { dependencies?: HardDependencies[] } = {}

  Returns Set<Workspace>

  all the workspaces marked as dependencies

getRecursiveWorkspaceDependents

• getRecursiveWorkspaceDependents(__namedParameters?: { dependencies?: HardDependencies[] }): Set<Workspace>

• Find workspaces which include the current workspace as a dependency/devDependency recursively.

  ---

  Parameters

  • __namedParameters: { dependencies?: HardDependencies[] } = {}

  Returns Set<Workspace>

  all the workspaces marked as dependents

persistManifest

• persistManifest(): Promise<void>

• Returns Promise<void>

setup

• setup(): Promise<void>

• Returns Promise<void>