suggestUtils

Index

Enumerations

• Modifier
• Strategy
• Target
• WorkspaceModifier

Type Aliases

• FetchDescriptorFromOptions
• NullableSuggestion
• Results
• Suggestion

Functions

• applyModifier
• extractDescriptorFromPath
• extractRangeModifier
• fetchDescriptorFrom
• findProjectDescriptors
• getModifier
• getSuggestedDescriptors
• makeWorkspaceDescriptor
• toWorkspaceModifier

Enumerations

Modifier

Modifier:

CARET

CARET: ^

EXACT

EXACT:

TILDE

TILDE: ~

Strategy

Strategy:

CACHE

CACHE: cache

If set, the suggest engine will offer to fulfill the request based on the versions of the package that are already within our cache.

KEEP

KEEP: keep

If set, the suggest engine will offer to keep the current version if the local workspace already depends on it.

LATEST

LATEST: latest

If set, the suggest engine will offer to fulfill the request by using whatever <request-name>@latest would return.

PROJECT

PROJECT: project

If set, the suggest engine will offer to fulfill the request by using any workspace whose name would match the request.

REUSE

REUSE: reuse

If set, the suggest engine will offer to fulfill the request by looking at the ranges currently used by the other workspaces in the project.

Target

Target:

DEVELOPMENT

DEVELOPMENT: devDependencies

PEER

PEER: peerDependencies

REGULAR

REGULAR: dependencies

WorkspaceModifier

WorkspaceModifier:

CARET

CARET: ^

EXACT

EXACT: *

TILDE

TILDE: ~

Type Aliases

FetchDescriptorFromOptions

FetchDescriptorFromOptions: { cache: Cache; project: Project; workspace: Workspace } & ({ modifier?: undefined; preserveModifier?: boolean | string } | { modifier: Modifier; preserveModifier?: undefined })

NullableSuggestion

NullableSuggestion: { descriptor: Descriptor | null; name: string; reason: string }

Type declaration

• descriptor: Descriptor | null

• name: string

• reason: string

Results

Results: { rejections: Error[]; suggestions: NullableSuggestion[] }

Type declaration

• rejections: Error[]

• suggestions: NullableSuggestion[]

Suggestion

Suggestion: { descriptor: Descriptor; name: string; reason: string }

Type declaration

• descriptor: Descriptor

• name: string

• reason: string

Functions

applyModifier

• applyModifier(descriptor: Descriptor, modifier: Modifier): Descriptor

• Parameters

  • descriptor: Descriptor

  • modifier: Modifier

  Returns Descriptor

extractDescriptorFromPath

• extractDescriptorFromPath(path: PortablePath, __namedParameters: { cwd: PortablePath; workspace: Workspace }): Promise<Descriptor>

• Parameters

  • path: PortablePath

  • __namedParameters: { cwd: PortablePath; workspace: Workspace }

  Returns Promise<Descriptor>

extractRangeModifier

• extractRangeModifier(range: string, __namedParameters: { project: Project }): string

• Parameters

  • range: string

  • __namedParameters: { project: Project }

  Returns string

fetchDescriptorFrom

• fetchDescriptorFrom(ident: Ident, range: string, __namedParameters: FetchDescriptorFromOptions): Promise<null | Descriptor>

• Parameters

  • ident: Ident

  • range: string

  • __namedParameters: FetchDescriptorFromOptions

  Returns Promise<null | Descriptor>

findProjectDescriptors

• findProjectDescriptors(ident: Ident, __namedParameters: { project: Project; target: Target }): Promise<Map<DescriptorHash, { descriptor: Descriptor; locators: Locator[] }>>

• Parameters

  • ident: Ident

  • __namedParameters: { project: Project; target: Target }

  Returns Promise<Map<DescriptorHash, { descriptor: Descriptor; locators: Locator[] }>>

getModifier

• getModifier(flags: { caret: boolean; exact: boolean; tilde: boolean }, project: Project): Modifier

• Parameters

  • flags: { caret: boolean; exact: boolean; tilde: boolean }

  • project: Project

  Returns Modifier

getSuggestedDescriptors

• getSuggestedDescriptors(request: Descriptor, __namedParameters: { cache: Cache; fixed: boolean; maxResults?: number; modifier: Modifier; project: Project; strategies: Strategy[]; target: Target; workspace: Workspace }): Promise<Results>

• Parameters

  • request: Descriptor

  • __namedParameters: { cache: Cache; fixed: boolean; maxResults?: number; modifier: Modifier; project: Project; strategies: Strategy[]; target: Target; workspace: Workspace }

  Returns Promise<Results>

makeWorkspaceDescriptor

• makeWorkspaceDescriptor(workspace: Workspace, modifier: Modifier): Descriptor

• Parameters

  • workspace: Workspace

  • modifier: Modifier

  Returns Descriptor

toWorkspaceModifier

• toWorkspaceModifier(modifier: Modifier): WorkspaceModifier

• Parameters

  • modifier: Modifier

  Returns WorkspaceModifier