Struct Resolver

pub struct Resolver<'a> {
    pub project_root: CachedPath,
    pub extensions: Extensions<'a>,
    pub index_file: &'a str,
    pub entries: Fields,
    pub flags: Flags,
    pub include_node_modules: Cow<'a, IncludeNodeModules>,
    pub conditions: ExportsCondition,
    pub module_dir_resolver: Option<Arc<dyn Fn(&str, &Path) -> Result<PathBuf, ResolverError> + Send + Sync>>,
    /* private fields */
}

Implements the Node.js module resolution algorithm.

Fields

project_root: CachedPath

The root path of the project.

extensions: Extensions<'a>

A list of file extensions to try when resolving.

index_file: &'a str

A file name (without extension) for the index file of a directory.

entries: Fields

package.json entry fields to try.

flags: Flags

Resolution features to enable.

include_node_modules: Cow<'a, IncludeNodeModules>

Configures which node_modules should be resolved.

conditions: ExportsCondition

package.json “exports” conditions to enable.

module_dir_resolver: Option<Arc<dyn Fn(&str, &Path) -> Result<PathBuf, ResolverError> + Send + Sync>>

A custom module directory resolution function, e.g. Yarn PnP.

Implementations

impl<'a> Resolver<'a>

pub fn node<C: Into<CacheCow<'a>>>(project_root: &Path, cache: C) -> Self

Creates a resolver with Node.js CommonJS settings.

pub fn node_esm<C: Into<CacheCow<'a>>>(project_root: &Path, cache: C) -> Self

Creates a resolver with Node.js ESM settings.

pub fn parcel<C: Into<CacheCow<'a>>>(project_root: &Path, cache: C) -> Self

Creates a resolver with Parcel settings.

pub fn resolve( &self, specifier: &str, from: &Path, specifier_type: SpecifierType, ) -> ResolveResult

Resolves a specifier relative to the given path, with default options.

pub fn resolve_with_options( &self, specifier: &str, from: &Path, specifier_type: SpecifierType, options: ResolveOptions, ) -> ResolveResult

Resolves a specifier relative to the given path, with custom options.

pub fn resolve_with_invalidations( &self, specifier: &str, from: &Path, specifier_type: SpecifierType, invalidations: &Invalidations, options: ResolveOptions, ) -> Result<ResolutionAndQuery, ResolverError>

Resolves a specifier with pre-existing Invalidations.

pub fn resolve_side_effects( &self, path: &Path, invalidations: &Invalidations, ) -> Result<bool, ResolverError>

Returns whether the given path has side effects, according to its parent package.json.

pub fn resolve_module_type( &self, path: &Path, invalidations: &Invalidations, ) -> Result<ModuleType, ResolverError>

Returns the module type (CommonJS, ESM, or JSON) of the given path, according to either its extension or the package.json type field.

pub fn cache(&self) -> &Cache

Returns the resolution cache.