bare-module-resolve

stable

bare-module-resolve — Low-level module resolution algorithm for Bare.

npm i bare-module-resolve

Usage

For synchronous resolution:

const resolve = require('bare-module-resolve')

function readPackage(url) {
  // Read and parse `url` if it exists, otherwise `null`
}

for (const resolution of resolve('./file.js', new URL('file:///directory/'), readPackage)) {
  console.log(resolution)
}

For asynchronous resolution:

const resolve = require('bare-module-resolve')

async function readPackage(url) {
  // Read and parse `url` if it exists, otherwise `null`
}

for await (const resolution of resolve('./file.js', new URL('file:///directory/'), readPackage)) {
  console.log(resolution)
}

Resolve specifier relative to parentURL, which must be a WHATWG URL instance. readPackage is called with a URL instance for every package manifest to be read and must either return the parsed JSON package manifest, if it exists, or null. If readPackage returns a promise, synchronous iteration is not supported.

Parameters

Parameter	Type	Default	Description
`specifier`	`string`	—	The module specifier to resolve, relative to `parentURL`.
`parentURL`	`URL`	—	The WHATWG `URL` that `specifier` is resolved against.
`readPackage?`	`(url: URL) => JSON \| null`	—	Called with the `URL` of each package manifest to read; must return the parsed JSON manifest if it exists, or `null`. Returning a promise disables synchronous iteration.

Returns Iterable<URL> — Yields each candidate resolution URL in the order the algorithm tries them, for the caller to test (e.g. check it exists); if none resolve, iteration simply ends without yielding further values — it does not throw or return null for an unresolved specifier.

Throws

INVALID_MODULE_SPECIFIER — the specifier (or a node:-protocol target) is not a valid module or package specifier: empty, a scoped package name missing the /, invalid characters, a relative-style node: specifier, an unmatched internal #import specifier, or a file: path containing an encoded / or \.
INVALID_PACKAGE_TARGET — a string target in a package's "exports" (or non-internal "imports") map does not start with ./.
PACKAGE_PATH_NOT_EXPORTED — the requested subpath is not defined by the package's "exports" map.
PACKAGE_IMPORT_NOT_DEFINED — an internal #specifier is not defined by the package's "imports" map.
UNSUPPORTED_ENGINE — the package's "engines" requirement is not satisfied by the corresponding opts.engines entry.

Types

`ResolveOptions`

interface ResolveOptions {
  builtinProtocol?: string
  builtins?: Builtins
  conditions?: Conditions
  defer?: string[]
  deferredProtocol?: string
  engines?: Engines
  extensions?: string[]
  imports?: ImportsMap
  matchedConditions?: string[]
  resolutions?: ResolutionsMap
}

_Source