readlink/README.md

expands fs.readlink() similar to readlink from GNU coreutils

# readlink

> Expand nested symbolic links to real paths.

[![npm](https://img.shields.io/npm/v/readlink.svg)](https://www.npmjs.com/package/readlink)
![Node version](https://img.shields.io/node/v/readlink.svg)
[![Build Status](https://travis-ci.org/ralphtheninja/readlink.svg?branch=master)](https://travis-ci.org/ralphtheninja/readlink)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

`fs.readlink` only handles paths to symbolic links and not paths that contain symbolic links. This module solves this use case. Similar to `readlink(1)` with `-f` flag.

## Usage

Assuming `/tmp/foo` is a symbolic link pointing to the folder `/tmp/bar/baz` which in turn contains `file`. Then `readlink` expands `/tmp/foo/file` to the real path, e.g. `/tmp/bar/baz/file`.

```js
const readlink = require('readlink')
readlink('/tmp/foo/file', (err, path) => {
  console.log(path) // /tmp/bar/baz/file
})

```

## API

### `readlink(path, cb)`

Where `path` is a string and `cb` is a node style callback with `err` and `result`.

### `readlink.sync(path)`

Sync version.

## License

MIT