VirtualFetcher

Fetchers are the component tasked from taking a locator and fetching its file data from whatever location the fetcher deems right. For example, the npm fetcher would download them from the npm registry while the workspace fetcher would simply return an plain link to the filesystem.

Implements

• Fetcher

Index

Constructors

• constructor

Methods

• fetch
• getLocalPath
• getLocatorFilename
• supports

Constructors

constructor

• new VirtualFetcher(): VirtualFetcher

• Returns VirtualFetcher

Methods

fetch

• fetch(locator: Locator, opts: FetchOptions): Promise<{ checksum?: null | string; discardFromLookup?: boolean; localPath?: null | PortablePath; packageFs: AliasFS<PortablePath>; prefixPath: PortablePath; releaseFs?: () => void }>

• Implementation of Fetcher.fetch

  This function must return a object describing where the package manager can find the data for the specified package on disk.

  The return value is a more complex than a regular path (cf FetchResult) because the fetchers are allowed to return virtual paths that point to things that don't actually exist (for example directories stored within zip archives).

  ---

  Parameters

  • locator: Locator

    The source locator.

  • opts: FetchOptions

    The fetch options.

  Returns Promise<{ checksum?: null | string; discardFromLookup?: boolean; localPath?: null | PortablePath; packageFs: AliasFS<PortablePath>; prefixPath: PortablePath; releaseFs?: () => void }>

getLocalPath

• getLocalPath(locator: Locator, opts: FetchOptions): null | PortablePath

• Implementation of Fetcher.getLocalPath

  This function must return the local path for the given package. The local path is the one that's used to resolve relative dependency sources, for example "file:./foo".

  ---

  Parameters

  • locator: Locator

    The source locator.

  • opts: FetchOptions

    The fetch options.

  Returns null | PortablePath

getLocatorFilename

• getLocatorFilename(locator: Locator): Filename

• Parameters

  • locator: Locator

  Returns Filename

supports

• supports(locator: Locator): boolean

• Implementation of Fetcher.supports

  This function must return true if the specified locator is understood by this resolver (only its syntax is checked, it doesn't have to be valid and it's fine if the fetch ends up returning a 404).

  ---

  Parameters

  • locator: Locator

    The locator that needs to be validated.

  Returns boolean