Blame view

node_modules/resolve-from/readme.md 1.67 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
  # resolve-from [![Build Status](https://travis-ci.org/sindresorhus/resolve-from.svg?branch=master)](https://travis-ci.org/sindresorhus/resolve-from)
  
  > Resolve the path of a module like [`require.resolve()`](https://nodejs.org/api/globals.html#globals_require_resolve) but from a given path
  
  
  ## Install
  
  ```
  $ npm install --save resolve-from
  ```
  
  
  ## Usage
  
  ```js
  const resolveFrom = require('resolve-from');
  
  // There is a file at `./foo/bar.js`
  
  resolveFrom('foo', './bar');
  //=> '/Users/sindresorhus/dev/test/foo/bar.js'
  ```
  
  
  ## API
  
  ### resolveFrom(fromDir, moduleId)
  
  Like `require()`, throws when the module can't be found.
  
  ### resolveFrom.silent(fromDir, moduleId)
  
  Returns `null` instead of throwing when the module can't be found.
  
  #### fromDir
  
  Type: `string`
  
  Directory to resolve from.
  
  #### moduleId
  
  Type: `string`
  
  What you would use in `require()`.
  
  
  ## Tip
  
  Create a partial using a bound function if you want to resolve from the same `fromDir` multiple times:
  
  ```js
  const resolveFromFoo = resolveFrom.bind(null, 'foo');
  
  resolveFromFoo('./bar');
  resolveFromFoo('./baz');
  ```
  
  
  ## Related
  
  - [resolve-cwd](https://github.com/sindresorhus/resolve-cwd) - Resolve the path of a module from the current working directory
  - [req-from](https://github.com/sindresorhus/req-from) - Require a module from a given path
  - [req-cwd](https://github.com/sindresorhus/req-cwd) - Require a module from the current working directory
  - [resolve-pkg](https://github.com/sindresorhus/resolve-pkg) - Resolve the path of a package regardless of it having an entry point
  - [lazy-req](https://github.com/sindresorhus/lazy-req) - Require modules lazily
  
  
  ## License
  
  MIT © [Sindre Sorhus](https://sindresorhus.com)