Struct nodejs_resolver::Options

source ·

pub struct Options {Show 16 fields
    pub extensions: Vec<String>,
    pub enforce_extension: EnforceExtension,
    pub alias: Vec<(String, Vec<AliasMap>)>,
    pub prefer_relative: bool,
    pub external_cache: Option<Arc<Cache>>,
    pub symlinks: bool,
    pub description_file: String,
    pub resolve_to_context: bool,
    pub main_files: Vec<String>,
    pub main_fields: Vec<String>,
    pub browser_field: bool,
    pub condition_names: HashSet<String>,
    pub tsconfig: Option<PathBuf>,
    pub modules: Vec<String>,
    pub fallback: Vec<(String, Vec<AliasMap>)>,
    pub fully_specified: bool,
}

Fields§

§extensions: Vec<String>

Tried detect file with this extension. Default is [".js", ".json", ".node"]

§enforce_extension: EnforceExtension

Enforce that a extension from extensions must be used. Default is Auto.

§alias: Vec<(String, Vec<AliasMap>)>

Maps key to value. Default is vec![]. The reason for using Vec instead HashMap to keep the order.

§prefer_relative: bool

Prefer to resolve request as relative request and fallback to resolving as modules. Default is false

§external_cache: Option<Arc<Cache>>

Use of cache defined external, it designed to shared the info of description_file in different resolver.

If external_cache is None, use default cache in resolver.
If external_cache.is_some() is true, use this cache.

Default is None.

§symlinks: bool

Whether to resolve the real path when the result is a symlink. Default is true.

§description_file: String

A JSON file to describing this lib information. Default is "package.json".

§resolve_to_context: bool

Resolve to a context instead of a file. Default is false

§main_files: Vec<String>

Main file in this directory. Default is ["index"].

§main_fields: Vec<String>

Main fields in Description. Default is ["main"].

§browser_field: bool

Whether read and parse "browser" filed in package.json. Default is false

§condition_names: HashSet<String>

Condition names for exports filed. Note that its type is a HashSet, because the priority is related to the order in which the export field fields are written. Default is Set(["node"]).

§tsconfig: Option<PathBuf>

When this filed exists, it tries to read baseURL and paths in the corresponding tsconfig, and processes the mappings. Default is None.

§modules: Vec<String>

A list of directories to resolve modules from, can be absolute path or folder name. Default is ["node_modules"]

§fallback: Vec<(String, Vec<AliasMap>)>

Same as alias, but only used if default resolving fails. Default is [].

§fully_specified: bool

Request passed to resolve is already fully specified and extensions or main files are not resolved for it. Default is false.