Skip to content

Commit 8f14348

Browse files
chore(release): 1.1.3 [skip ci]
## [1.1.3](v1.1.2...v1.1.3) (2020-04-19) ### Bug Fixes * **docs:** fix contribution guide wording ([76985fb](76985fb))
1 parent 76985fb commit 8f14348

2 files changed

Lines changed: 38 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
## [1.1.3](https://github.com/nodewell/path/compare/v1.1.2...v1.1.3) (2020-04-19)
2+
3+
4+
### Bug Fixes
5+
6+
* **docs:** fix contribution guide wording ([76985fb](https://github.com/nodewell/path/commit/76985fbf1d9feaeb06bb3cffac7c15355f47fee0))
7+
18
## [1.1.2](https://github.com/nodewell/path/compare/v1.1.1...v1.1.2) (2020-04-17)
29

310

docs/API.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<a name="module_@nodewell/path"></a>
2+
3+
## @nodewell/path
4+
<a name="exp_module_@nodewell/path--module.exports"></a>
5+
6+
### module.exports(paths) ⇒ <code>string</code> ⏏
7+
Processes and returns the path segments.
8+
9+
**Returns**: <code>string</code> - Returns the processed path segments.
10+
<table>
11+
<thead>
12+
<tr>
13+
<th>Param</th><th>Type</th><th>Description</th>
14+
</tr>
15+
</thead>
16+
<tbody>
17+
<tr>
18+
<td>paths</td><td><code>string</code> | <code>Array.&lt;string&gt;</code></td><td><p>The path segments to process.</p>
19+
</td>
20+
</tr> </tbody>
21+
</table>
22+
23+
**Example**
24+
```js
25+
// assuming your project's root is '/home/user/project'
26+
const path = require('@nodewell/path')
27+
28+
path('@') // '/home/user/project'
29+
path('@/src') // '/home/user/project/src'
30+
path('@/src/*.js') // '/home/user/project/src/*.js'
31+
```

0 commit comments

Comments
 (0)