resolve-dependency
v1.0.3
Published
Find The File That Dependency Path Resolves To.
Downloads
369
Maintainers
Readme
resolve-dependency
resolve-dependency
Finds The File That Dependency Path Resolves To.
yarn add -E resolve-dependency
Table Of Contents
- Table Of Contents
- API
async resolveDependency(path: string, relativeFrom?: string): { path: string, isDir: boolean }
- Copyright
API
The package is available by importing its default function:
import resolveDependency from 'resolve-dependency'
async resolveDependency(
path: string,
relativeFrom?: string,
): { path: string, isDir: boolean }
For the path that is used to require a module from another module, find the destination of the actual file on the file system. This includes the index JS and JSX files of directories. The second relativeFrom
argument is used to point to the file in which the path is required from.
/* yarn example/ */
import resolveDependency from 'resolve-dependency'
import { resolve } from 'path'
(async () => {
// 1. Resolve index.js from directory
const res = await resolveDependency('./example/dir')
console.log(res)
// 2. Resolve index.jsx from directory
const res2 = await resolveDependency('./example/jsx')
console.log(res2)
// 3. Resolve file without extension
const res3 = await resolveDependency('./example/dir/index')
console.log(res3)
// 4. Resolve relative dependency
const res4 = await resolveDependency('./lib', 'example/jsx/index.js')
console.log(res4)
// 4. Resolve absolute dependency
const res5 = await resolveDependency(
'./lib', resolve('example/jsx/index.js'))
console.log(res5)
})()
{ path: 'example/dir/index.js', isDir: true }
{ path: 'example/jsx/index.jsx', isDir: true }
{ path: 'example/dir/index.js', isDir: false }
{ path: 'example/jsx/lib/index.js', isDir: true }
{ path: '/Users/zavr/adc/resolve-dependency/example/jsx/lib/index.js',
isDir: true }