resolve
Last updated
Last updated
implements the node require.resolve()
algorithm such that you can require.resolve()
on behalf of a file asynchronously and synchronously
asynchronously resolve:
synchronously resolve:
Asynchronously resolve the module path string id
into cb(err, res [, pkg])
, where pkg
(if defined) is the data from package.json
.
options are:
opts.basedir - directory to begin resolving from
opts.package - package.json
data applicable to the module being loaded
opts.extensions - array of file extensions to search in order
opts.readFile - how to read files asynchronously
opts.isFile - function to asynchronously test whether a file exists
opts.isDirectory - function to asynchronously test whether a directory exists
opts.packageFilter(pkg, pkgfile, dir)
- transform the parsed package.json contents before looking at the "main" field
pkg - package data
pkgfile - path to package.json
dir - directory for package.json
opts.pathFilter(pkg, path, relativePath)
- transform a path within a package
pkg - package data
path - the path being resolved
relativePath - the path relative from the package.json location
returns - a relative path that will be joined from the package.json location
opts.paths - require.paths array to use if nothing is found on the normal node_modules
recursive walk (probably don't use this)
For advanced users, paths
can also be a opts.paths(request, start, opts)
function
request - the import specifier being resolved
start - lookup path
getNodeModulesDirs - a thunk (no-argument function) that returns the paths using standard node_modules
resolution
opts - the resolution options
opts.packageIterator(request, start, opts)
- return the list of candidate paths where the packages sources may be found (probably don't use this)
request - the import specifier being resolved
start - lookup path
getPackageCandidates - a thunk (no-argument function) that returns the paths using standard node_modules
resolution
opts - the resolution options
opts.moduleDirectory - directory (or directories) in which to recursively look for modules. default: "node_modules"
opts.preserveSymlinks - if true, doesn't resolve basedir
to real path before resolving. This is the way Node resolves dependencies when executed with the --preserve-symlinks flag. Note: this property is currently true
by default but it will be changed to false
in the next major version because Node's resolution algorithm does not preserve symlinks by default.
default opts
values:
Synchronously resolve the module path string id
, returning the result and throwing an error when id
can't be resolved.
options are:
opts.basedir - directory to begin resolving from
opts.extensions - array of file extensions to search in order
opts.readFile - how to read files synchronously
opts.isFile - function to synchronously test whether a file exists
opts.isDirectory - function to synchronously test whether a directory exists
opts.packageFilter(pkg, dir)
- transform the parsed package.json contents before looking at the "main" field
pkg - package data
dir - directory for package.json (Note: the second argument will change to "pkgfile" in v2)
opts.pathFilter(pkg, path, relativePath)
- transform a path within a package
pkg - package data
path - the path being resolved
relativePath - the path relative from the package.json location
returns - a relative path that will be joined from the package.json location
opts.paths - require.paths array to use if nothing is found on the normal node_modules
recursive walk (probably don't use this)
For advanced users, paths
can also be a opts.paths(request, start, opts)
function
request - the import specifier being resolved
start - lookup path
getNodeModulesDirs - a thunk (no-argument function) that returns the paths using standard node_modules
resolution
opts - the resolution options
opts.packageIterator(request, start, opts)
- return the list of candidate paths where the packages sources may be found (probably don't use this)
request - the import specifier being resolved
start - lookup path
getPackageCandidates - a thunk (no-argument function) that returns the paths using standard node_modules
resolution
opts - the resolution options
opts.moduleDirectory - directory (or directories) in which to recursively look for modules. default: "node_modules"
opts.preserveSymlinks - if true, doesn't resolve basedir
to real path before resolving. This is the way Node resolves dependencies when executed with the --preserve-symlinks flag. Note: this property is currently true
by default but it will be changed to false
in the next major version because Node's resolution algorithm does not preserve symlinks by default.
default opts
values:
Return whether a package is in core.
With npm do:
MIT