budibase/packages/common/node_modules/realpath-native/README.md

1.3 KiB

realpath-native

Use the system's native realpath

NPM Version Linux & Mac Build Status

Greenkeeper Dependency Status

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:

$ npm install realpath-native

Usage

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