summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/which/node_modules/is-absolute/node_modules/is-relative/README.md
blob: 5d7a2a2aabb9288d3c2942b7035fc5f506305559 (plain)
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
# is-relative [![NPM version](https://badge.fury.io/js/is-relative.svg)](http://badge.fury.io/js/is-relative)

> Returns `true` if the path appears to be relative.

## Install
### Install with [npm](npmjs.org)

```bash
npm i is-relative --save
```

## Usage
### [isRelative](index.js#L16)

* `filepath` **{String}**: Path to test.
* `returns`: {Boolean}

```js
var isRelative = require('is-relative');
isRelative('README.md');
//=> true
```


## Author

**Jon Schlinkert**

+ [github/jonschlinkert](https://github.com/jonschlinkert)
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)

## License
Copyright (c) 2014 Jon Schlinkert
Released under the MIT license

***

_This file was generated by [verb](https://github.com/assemble/verb) on November 17, 2014._