# is-linked

> Check if your module is linked.

Latest version **1.0.1** (published 2021-02-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install is-linked
pnpm add is-linked
yarn add is-linked
bun add is-linked
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2021-02-13 |
| First published | 2021-02-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 12.0.0 |
| Dependencies | 2 |
| Unpacked size | 93.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Özüm Eldoğan |
| Maintainers | ozum |
| Keywords | npm, yarn, link |

## Links

- npm: https://www.npmjs.com/package/is-linked
- Repository: https://github.com/ozum/is-linked
- Issues: https://github.com/ozum/is-linked/issues
- npm.io page: https://npm.io/package/is-linked

## Dependencies (2)

- [global-dirs](https://npm.io/package/global-dirs.md) ^3.0.0
- [top-pkg-dir](https://npm.io/package/top-pkg-dir.md) ^0.0.3

## Recent versions

- 1.0.1 (latest) — 2021-02-13
- 1.0.0 — 2021-02-13

## README

# is-linked

Check if your module is linked.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [Installation](#installation)
- [Synopsis](#synopsis)
- [Details](#details)
- [API](#api)
- [is-linked](#is-linked)
  - [Table of contents](#table-of-contents)
    - [Functions](#functions)
  - [Functions](#functions-1)
    - [default](#default)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

# Installation

# Synopsis

```ts
import isLinked from "is-linked";

await isLinked();
await isLinked("some-module");
```

# Details

Check if a module is linked by `npm` or `yarn`. By default checks top-most module.

<!-- usage -->

<!-- commands -->

# API

<a name="readmemd"></a>

is-linked

# is-linked

## Table of contents

### Functions

- [default](#default)

## Functions

### default

▸ **default**(`module?`: _string_): _Promise_<_boolean_\>

Returns whether a module is linked by `npm` or `yarn`. If no module name is provided, top-most package name is used.

#### Parameters:

| Name      | Type     | Description                                                            |
| --------- | -------- | ---------------------------------------------------------------------- |
| `module?` | _string_ | is the name of the module to check. Defaults to top-most package name. |

**Returns:** _Promise_<_boolean_\>

whether module is linked.

Defined in: [index.ts:26](https://github.com/ozum/is-linked/blob/ebb8abc/src/index.ts#L26)

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