# path-root

> Get the root of a posix or windows filepath.

Latest version **0.1.1** (published 2016-03-29) · MIT license · 0 weekly downloads

## Install

```sh
npm install path-root
pnpm add path-root
yarn add path-root
bun add path-root
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2016-03-29 |
| First published | 2016-03-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Jon Schlinkert |
| Maintainers | jonschlinkert |
| Keywords | path, root |

## Links

- npm: https://www.npmjs.com/package/path-root
- Repository: https://github.com/jonschlinkert/path-root
- Issues: https://github.com/jonschlinkert/path-root/issues
- npm.io page: https://npm.io/package/path-root

## Dependencies (1)

- [path-root-regex](https://npm.io/package/path-root-regex.md) ^0.1.0

## Alternatives

- [base64url](https://npm.io/package/base64url.md) — 6.1M weekly downloads
- [get-installed-path](https://npm.io/package/get-installed-path.md) — 502.9K weekly downloads
- [@uppy/url](https://npm.io/package/@uppy/url.md) — 185.8K weekly downloads
- [@d3fc/d3fc-shape](https://npm.io/package/@d3fc/d3fc-shape.md) — 16.2K weekly downloads
- [localizer](https://npm.io/package/localizer.md) — 226 weekly downloads

## Recent versions

- 0.1.1 (latest) — 2016-03-29
- 0.1.0 — 2016-03-29

## README

# path-root [![NPM version](https://img.shields.io/npm/v/path-root.svg?style=flat)](https://www.npmjs.com/package/path-root) [![NPM downloads](https://img.shields.io/npm/dm/path-root.svg?style=flat)](https://npmjs.org/package/path-root) [![Build Status](https://img.shields.io/travis/jonschlinkert/path-root.svg?style=flat)](https://travis-ci.org/jonschlinkert/path-root)

> Get the root of a posix or windows filepath.

You might also be interested in [parse-filepath](https://github.com/jonschlinkert/parse-filepath).

## Install

Install with [npm](https://www.npmjs.com/):

```sh
$ npm install path-root --save
```

## Usage

```js
var pathRoot = require('path-root');
```

**Examples**

```js
pathRoot('\\\\server\\share\\abc');
//=> '\\\\server\\share\\'

pathRoot('\\\\server foo\\some folder\\base-file.js');
//=> '\\\\server foo\\some folder\\'

pathRoot('\\\\?\\UNC\\server\\share');
//=> '\\\\?\\UNC\\'

pathRoot('foo/bar/baz.js');
//=> ''

pathRoot('c:\\foo\\bar\\baz.js');
//=> 'c:\\'

pathRoot('\\\\slslslsl\\admin$\\system32');
//=> '\\\\slslslsl\\admin$\\'

pathRoot('/foo/bar/baz.js');
//=> '/'
```

## Related projects

You might also be interested in these projects:

* [is-absolute](https://www.npmjs.com/package/is-absolute): Polyfill for node.js `path.isAbolute`. Returns true if a file path is absolute. | [homepage](https://github.com/jonschlinkert/is-absolute)
* [parse-filepath](https://www.npmjs.com/package/parse-filepath): Parse a filepath into an object. Falls back on the native node.js `path.parse` method if… [more](https://www.npmjs.com/package/parse-filepath) | [homepage](https://github.com/jonschlinkert/parse-filepath)
* [path-root-regex](https://www.npmjs.com/package/path-root-regex): Regular expression for getting the root of a posix or windows filepath. | [homepage](https://github.com/regexhq/path-root-regex)

## Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/path-root/issues/new).

## Building docs

Generate readme and API documentation with [verb](https://github.com/verbose/verb):

```sh
$ npm install verb && npm run docs
```

Or, if [verb](https://github.com/verbose/verb) is installed globally:

```sh
$ verb
```

## Running tests

Install dev dependencies:

```sh
$ npm install -d && npm test
```

## Author

**Jon Schlinkert**

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

## License

Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT license](https://github.com/jonschlinkert/path-root/blob/master/LICENSE).

***

_This file was generated by [verb](https://github.com/verbose/verb), v, on March 29, 2016._

---
_Source: https://npm.io/package/path-root · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._