https://github.com/artdecocode/resolve-dependency
Find The File That Dependency Path Resolves To.
https://github.com/artdecocode/resolve-dependency
Last synced: 11 months ago
JSON representation
Find The File That Dependency Path Resolves To.
- Host: GitHub
- URL: https://github.com/artdecocode/resolve-dependency
- Owner: artdecocode
- License: mit
- Created: 2019-02-05T11:22:12.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-02-04T01:57:50.000Z (almost 6 years ago)
- Last Synced: 2025-02-08T23:35:40.957Z (11 months ago)
- Language: JavaScript
- Homepage: https://artd.eco
- Size: 43 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# resolve-dependency
[](https://npmjs.org/package/resolve-dependency)
`resolve-dependency` Finds The File That Dependency Path Resolves To.
```sh
yarn add -E resolve-dependency
```
## Table Of Contents
- [Table Of Contents](#table-of-contents)
- [API](#api)
- [`async resolveDependency(path: string, relativeFrom?: string): { path: string, isDir: boolean }`](#async-resolvedependencypath-stringrelativefrom-string--path-string-isdir-boolean-)
- [Copyright](#copyright)
## API
The package is available by importing its default function:
```js
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.
```js
/* 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 }
```
## Copyright
© Art Deco 2019
Tech Nation Visa Sucks
