# @pipeletteio/nop

> A simple nop function helper

Latest version **1.0.5** (published 2022-04-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @pipeletteio/nop
pnpm add @pipeletteio/nop
yarn add @pipeletteio/nop
bun add @pipeletteio/nop
```

## 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.5 |
| Published | 2022-04-24 |
| First published | 2020-04-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >= 12.0.0 |
| Dependencies | 0 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | AshLePoney |
| Maintainers | ashed |

## Links

- npm: https://www.npmjs.com/package/@pipeletteio/nop
- Repository: https://github.com/pipeletteio/nop
- Homepage: https://github.com/pipeletteio/nop#readme
- Issues: https://github.com/pipeletteio/nop/issues
- npm.io page: https://npm.io/package/@pipeletteio/nop

## Recent versions

- 1.0.5 (latest) — 2022-04-24
- 1.0.4 — 2022-02-06
- 1.0.3 — 2022-02-06
- 1.0.2 — 2022-02-05
- 1.0.1 — 2022-02-05
- 1.0.0 — 2020-04-16

## README

<h1 align="center">
  <p>@pipeletteio/nop</p>
</h1>

<p align="center">A simple nop (no-op) function helper. Nop is a function that does nothing.</p>

<p align="center">
  <a alt="Build Status" href="https://github.com/pipeletteio/nop/actions?query=workflow">
    <img src="https://github.com/pipeletteio/nop/workflows/Build/badge.svg"/>
  </a>
  <a alt="Npm version" href="https://www.npmjs.com/package/@pipeletteio/nop?activeTab=versions">
    <img src="https://img.shields.io/npm/v/@pipeletteio/nop.svg?longCache=true&logo=npm">
  </a>
  <a alt="CodeClimate coverage" href="https://codeclimate.com/github/pipeletteio/nop/test_coverage">
    <img src="https://api.codeclimate.com/v1/badges/0dd2d5bb4e76e524531e/test_coverage"/>
  </a>
  <a alt="CodeClimate maintainability" href="https://codeclimate.com/github/pipeletteio/nop/maintainability">
    <img src="https://api.codeclimate.com/v1/badges/0dd2d5bb4e76e524531e/maintainability"/>
  </a>
  <a alt="Node requierement version" href="https://github.com/pipeletteio/nop/blob/master/package.json">
    <img src="https://img.shields.io/node/v/@pipeletteio/nop.svg?longCache=true"/>
  </a>
</p>

## Installation
```bash
npm install @pipeletteio/nop
```

## Example

```javascript
import { nop, isNop } from '@pipeletteio/nop';
// const { nop, isNop } = require('@pipeletteio/nop');

isNop(nop); // => true

isNop(function () {}); // => false
```

## Docs
Read [documentation](https://pipeletteio.github.io/nop) for more informations.

## API

#### nop

The nop function which will be used to replace the non cancellable callables.

|   argument   |    type   | details |
|--------------|-----------|---------|
|    ...arg    |   any[]   | ...     |

Return void.

#### isNop

Check if the argument is the nop function.

|   argument   |    type   |         details          |
|--------------|-----------|--------------------------|
|      arg     |    any    | The checked argument.    |

Return a boolean.

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