mirror of
https://github.com/cachix/install-nix-action.git
synced 2025-06-08 18:04:29 +00:00
v7
This commit is contained in:
parent
033d472283
commit
49df04613e
6774 changed files with 1602535 additions and 1 deletions
60
node_modules/realpath-native/README.md
generated
vendored
Normal file
60
node_modules/realpath-native/README.md
generated
vendored
Normal file
|
@ -0,0 +1,60 @@
|
|||
# realpath-native
|
||||
|
||||
> Use the system's native `realpath`
|
||||
|
||||
[![NPM Version][npm-image]][npm-url]
|
||||
[![Linux & Mac Build Status][travis-image]][travis-url]
|
||||
|
||||
[![Greenkeeper Dependency Status][greenkeeper-image]][greenkeeper-url]
|
||||
|
||||
Node 9.3 added `fs.realpath(Sync).native`. On older Nodes you have to use
|
||||
`process.binding` to access the same function. This module does that check for
|
||||
you.
|
||||
|
||||
The advantage of the native `realpath` over `fs.realpath` is that the native one
|
||||
better supports paths on Windows.
|
||||
|
||||
On node 4 the function uses the old `fs.realpath` function.
|
||||
|
||||
## Install
|
||||
|
||||
Install the module with `npm`:
|
||||
|
||||
```sh
|
||||
$ npm install realpath-native
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```js
|
||||
const realpath = require('realpath-native');
|
||||
|
||||
realpath('some-path'); // returns a promise
|
||||
|
||||
realpath.sync('some-path');
|
||||
```
|
||||
|
||||
## API
|
||||
|
||||
### realpath(path)
|
||||
|
||||
Returns a promise for the resolved path of the input.
|
||||
|
||||
#### path
|
||||
|
||||
Type: `string`
|
||||
|
||||
### realpath.sync(path)
|
||||
|
||||
Returns the resolved path of the input synchronously.
|
||||
|
||||
#### path
|
||||
|
||||
Type: `string`
|
||||
|
||||
[npm-url]: https://npmjs.org/package/realpath-native
|
||||
[npm-image]: https://img.shields.io/npm/v/realpath-native.svg
|
||||
[travis-url]: https://travis-ci.org/SimenB/realpath-native
|
||||
[travis-image]: https://img.shields.io/travis/SimenB/realpath-native/master.svg
|
||||
[greenkeeper-url]: https://greenkeeper.io/
|
||||
[greenkeeper-image]: https://badges.greenkeeper.io/SimenB/realpath-native.svg
|
Loading…
Add table
Add a link
Reference in a new issue