Blame view

node_modules/find-up/readme.md 1.78 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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
  # find-up [![Build Status: Linux and macOS](https://travis-ci.org/sindresorhus/find-up.svg?branch=master)](https://travis-ci.org/sindresorhus/find-up) [![Build Status: Windows](https://ci.appveyor.com/api/projects/status/l0cyjmvh5lq72vq2/branch/master?svg=true)](https://ci.appveyor.com/project/sindresorhus/find-up/branch/master)
  
  > Find a file by walking up parent directories
  
  
  ## Install
  
  ```
  $ npm install --save find-up
  ```
  
  
  ## Usage
  
  ```
  /
  └── Users
  		└── sindresorhus
  				├── unicorn.png
  				└── foo
  						└── bar
  								├── baz
  								└── example.js
  ```
  
  ```js
  // example.js
  const findUp = require('find-up');
  
  findUp('unicorn.png').then(filepath => {
  	console.log(filepath);
  	//=> '/Users/sindresorhus/unicorn.png'
  });
  
  findUp(['rainbow.png', 'unicorn.png']).then(filepath => {
  	console.log(filepath);
  	//=> '/Users/sindresorhus/unicorn.png'
  });
  ```
  
  
  ## API
  
  ### findUp(filename, [options])
  
  Returns a `Promise` for the filepath or `null`.
  
  ### findUp([filenameA, filenameB], [options])
  
  Returns a `Promise` for the first filepath found (by respecting the order) or `null`.
  
  ### findUp.sync(filename, [options])
  
  Returns a filepath or `null`.
  
  ### findUp.sync([filenameA, filenameB], [options])
  
  Returns the first filepath found (by respecting the order) or `null`.
  
  #### filename
  
  Type: `string`
  
  Filename of the file to find.
  
  #### options
  
  ##### cwd
  
  Type: `string`<br>
  Default: `process.cwd()`
  
  Directory to start from.
  
  
  ## Related
  
  - [find-up-cli](https://github.com/sindresorhus/find-up-cli) - CLI for this module
  - [pkg-up](https://github.com/sindresorhus/pkg-up) - Find the closest package.json file
  - [pkg-dir](https://github.com/sindresorhus/pkg-dir) - Find the root directory of an npm package
  
  
  ## License
  
  MIT © [Sindre Sorhus](https://sindresorhus.com)