# get-symlinks

> Get all symbolic link (file symlinks) using glob

Latest version **3.0.1** (published 2018-12-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install get-symlinks
pnpm add get-symlinks
yarn add get-symlinks
bun add get-symlinks
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.1 |
| Published | 2018-12-14 |
| First published | 2016-10-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 2 |
| Unpacked size | 4.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Guntur Poetra |
| Maintainers | guntur |
| Keywords | fetch, files, get, glob, links, symbolic, symlinks, system, utility |

## Links

- npm: https://www.npmjs.com/package/get-symlinks
- Repository: https://github.com/iguntur/get-symlinks
- Homepage: https://github.com/iguntur/get-symlinks#readme
- Issues: https://github.com/iguntur/get-symlinks/issues
- npm.io page: https://npm.io/package/get-symlinks

## Dependencies (2)

- [globby](https://npm.io/package/globby.md) ^8.0.1
- [is-symbolic-link](https://npm.io/package/is-symbolic-link.md) ^2.0.3

## Alternatives

- [unionfs](https://npm.io/package/unionfs.md) — 2.2M weekly downloads
- [path-starts-with](https://npm.io/package/path-starts-with.md) — 35.9K weekly downloads
- [redzip](https://npm.io/package/redzip.md) — 1.2K weekly downloads
- [vscode-anymatch](https://npm.io/package/vscode-anymatch.md) — 848 weekly downloads
- [@ledgerhq/coin-filecoin](https://npm.io/package/@ledgerhq/coin-filecoin.md) — 793 weekly downloads

## Recent versions

- 3.0.1 (latest) — 2018-12-14
- 3.0.0 — 2018-12-02
- 2.0.0 — 2017-12-04
- 1.0.2 — 2016-11-01
- 1.0.1 — 2016-10-17
- 1.0.0 — 2016-10-16
- 0.1.0 — 2016-10-08

## README

# get-symlinks

[![Travis CI](https://img.shields.io/travis/iguntur/get-symlinks.svg?style=flat-square)](https://travis-ci.org/iguntur/get-symlinks)
[![node](https://img.shields.io/node/v/get-symlinks.svg?style=flat-square)](#)
[![npm](https://img.shields.io/npm/v/get-symlinks.svg?style=flat-square)](https://www.npmjs.org/package/get-symlinks)
[![PRs](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](#)

---

> Get all symbolic link (file symlinks) using glob


## Install

```console
$ npm install get-symlinks
```


## Usage

```js
const getSymlinks = require('get-symlinks');

getSymlinks(['/home/guntur/.*']).then(symlinks => {
    console.log(symlinks);
});

const symlinks = getSymlinks.sync(['/home/guntur/.*', '!/home/guntur/.*rc']);
console.log(symlinks);
```


## API

### getSymlinks(`patterns`, `[options]`)

- Params:
  - `patterns`: `<string | string[]>` _(required)_ - See the [globby patterns](https://github.com/sindresorhus/globby#patterns).
  - `options`: `<object>` _(optional)_ - See the [globby options](https://github.com/sindresorhus/globby#options).
- Returns: `<Promise<string[]>` - An array of symlinks paths.

### getSymlinks.sync(`patterns`, `[options]`)

- Params:
  - `patterns`: `<string | string[]>` _(required)_ - See the [globby patterns](https://github.com/sindresorhus/globby#patterns).
  - `options`: `<object>` _(optional)_ - See the [globby options](https://github.com/sindresorhus/globby#options).
- Returns: `<string[]>` - An array of symlinks paths.


## Related

- [del-symlinks](https://github.com/iguntur/del-symlinks) - Delete symlinks using glob.
- [is-symbolic-link](https://github.com/iguntur/is-symbolic-link) - Check if PATH is symbolic link
- [make-symlinks](https://github.com/iguntur/make-symlinks) - Create symbolic link (symlinks) using glob.


## License

MIT © [Guntur Poetra](https://github.com/iguntur)

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