Blame view

node_modules/import-cwd/readme.md 1.47 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
  # import-cwd [![Build Status](https://travis-ci.org/sindresorhus/import-cwd.svg?branch=master)](https://travis-ci.org/sindresorhus/import-cwd)
  
  > Import a module like with [`require()`](https://nodejs.org/api/globals.html#globals_require) but from the current working directory
  
  
  ## Install
  
  ```
  $ npm install --save import-cwd
  ```
  
  
  ## Usage
  
  ```js
  const importCwd = require('import-cwd');
  
  // Target module is at '/Users/sindresorhus/unicorn/foo.js'
  
  console.log(__dirname);
  //=> '/Users/sindresorhus/rainbow'
  
  console.log(process.cwd());
  //=> '/Users/sindresorhus/unicorn'
  
  const foo = importCwd('./foo');
  ```
  
  
  ## API
  
  ### importCwd(moduleId)
  
  Like `require()`, throws when the module can't be found.
  
  ### importCwd.silent(moduleId)
  
  Returns `null` instead of throwing when the module can't be found.
  
  #### moduleId
  
  Type: `string`
  
  What you would use in `require()`.
  
  
  ## Related
  
  - [import-from](https://github.com/sindresorhus/import-from) - Import a module from a given path
  - [resolve-from](https://github.com/sindresorhus/resolve-from) - Resolve the path of a module from a given path
  - [resolve-cwd](https://github.com/sindresorhus/resolve-cwd) - Resolve the path of 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
  - [import-lazy](https://github.com/sindresorhus/import-lazy) - Import modules lazily
  
  
  ## License
  
  MIT © [Sindre Sorhus](https://sindresorhus.com)