Struct ResolverGeneric 

pub struct ResolverGeneric<Fs> { /* private fields */ }

Generic implementation of the resolver, can be configured by the Cache trait

Implementations

impl<Fs: FileSystem> ResolverGeneric<Fs>

pub fn find_tsconfig<P: AsRef<Path>>( &self, path: P, ) -> Result<Option<Arc<TsConfig>>, ResolveError>

Finds the tsconfig to which this path belongs.

If the path is inside node_modules, this function always returns None.

Algorithm:

1. Search for tsconfig.json in ancestor directories.
2. If the path is not included in this tsconfig.json through the files, include, or exclude fields: 2.1. Search through project references until a referenced tsconfig includes this file. 2.2. If none of the references include this path, return the tsconfig.json found in step 1.

Errors

• Returns an error if the tsconfig is invalid, including any extended or referenced tsconfigs.

pub fn resolve_tsconfig<P: AsRef<Path>>( &self, path: P, ) -> Result<Arc<TsConfig>, ResolveError>

Resolve tsconfig.

The path can be:

• Path to a file with .json extension.
• Path to a file without .json extension, .json will be appended to filename.
• Path to a directory, where the filename is defaulted to tsconfig.json

Errors

• See ResolveError

impl<Fs: FileSystem> ResolverGeneric<Fs>

pub fn new(options: ResolveOptions) -> Self

pub fn new_with_file_system(file_system: Fs, options: ResolveOptions) -> Self

pub fn clone_with_options(&self, options: ResolveOptions) -> Self

Clone the resolver using the same underlying cache.

pub const fn options(&self) -> &ResolveOptions

Returns the options.

pub fn clear_cache(&self)

Clear the underlying cache.

Warning: The caller must ensure that there’re no ongoing resolution operations when calling this method. Otherwise, it may cause those operations to return an incorrect result.

pub fn resolve<P: AsRef<Path>>( &self, directory: P, specifier: &str, ) -> Result<Resolution, ResolveError>

Resolve specifier at an absolute path to a directory.

A specifier is the string passed to require or import, i.e. require("specifier") or import "specifier".

directory must be an absolute path to a directory where the specifier is resolved against. For CommonJS modules, it is the __dirname variable that contains the absolute path to the folder containing current module. For ECMAScript modules, it is the value of import.meta.url.

NOTE: TsconfigDiscovery::Auto does not work for this API, use ResolverGeneric::resolve_file instead.

Errors

• See ResolveError

pub fn resolve_file<P: AsRef<Path>>( &self, file: P, specifier: &str, ) -> Result<Resolution, ResolveError>

Resolve specifier for an absolute path to a file.

NOTE: TsconfigDiscovery::Auto only work for this API.

Errors

• See ResolveError

Panics

• If the provided path is not a file.

pub fn resolve_with_context<P: AsRef<Path>>( &self, directory: P, specifier: &str, tsconfig: Option<&TsConfig>, resolve_context: &mut ResolveContext, ) -> Result<Resolution, ResolveError>

Resolve specifier at absolute path with ResolveContext

Errors

• See ResolveError

Trait Implementations

impl<Fs> Debug for ResolverGeneric<Fs>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<Fs: FileSystem> Default for ResolverGeneric<Fs>

fn default() -> Self

Returns the “default value” for a type.