https://github.com/vovanr/toggle-in-array

Add or remove item from array
https://github.com/vovanr/toggle-in-array

array-manipulations utility

Last synced: about 1 month ago
JSON representation

Add or remove item from array

• Host: GitHub
• URL: https://github.com/vovanr/toggle-in-array
• Owner: VovanR
• License: mit
• Created: 2018-01-15T14:48:26.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-16T19:35:46.000Z (about 2 years ago)
• Last Synced: 2024-11-19T04:00:33.114Z (about 2 months ago)
• Topics: array-manipulations, utility
• Language: JavaScript
• Size: 158 KB
• Stars: 4
• Watchers: 3
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# toggle-in-array

[![Commitizen friendly][commitizen-image]][commitizen-url]

[![XO code style][codestyle-image]][codestyle-url]

[![NPM version][npm-image]][npm-url]

[![Build Status][build-image]][build-url]

[![Coveralls Status][coveralls-image]][coveralls-url]

> Add or remove item from array

## Install

```shell

npm install --save toggle-in-array

```

## Usage

```js

var toggleInArray = require('toggle-in-array');

toggleInArray([1, 2, 3], 2);

//=> [1, 3]

toggleInArray([1, 2, 3], 4);

//=> [1, 2, 3, 4]

toggleInArray(

  [{v: 1}, {v: 2}, {v: 3}],

  {v: 2},

  (a, b) => a.v === b.v

);

//=> [{v: 1}, {v: 3}]

```

## API

### `toggleInArray(array, value, [predicate])`

Returns an `Array` with `value` if `array` is not includes this `value`


Returns an `Array` without `value` if `array` is includes this `value`

#### array

*Required*


Type: `Array`

Array with values needs to toggle

#### value

*Required*


Type: `*`

Value to toggle in `array`

#### predicate

Type: `Function`


Default: `(a, b) => a === b` *Strict equality comparison*

Function that compare each `array` item to equal `value`

## License

MIT © [Vladimir Rodkin](https://github.com/VovanR)

[commitizen-url]: https://commitizen.github.io/cz-cli/

[commitizen-image]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square

[codestyle-url]: https://github.com/xojs/xo

[codestyle-image]: https://img.shields.io/badge/code_style-XO-5ed9c7.svg?style=flat-square

[npm-url]: https://npmjs.org/package/toggle-in-array

[npm-image]: https://img.shields.io/npm/v/toggle-in-array.svg?style=flat-square

[build-url]: https://github.com/VovanR/toggle-in-array/actions/workflows/test-workflow.yml

[build-image]: https://img.shields.io/github/actions/workflow/status/vovanr/toggle-in-array/test-workflow.yml?branch=master&style=flat-square

[coveralls-url]: https://coveralls.io/r/VovanR/toggle-in-array

[coveralls-image]: https://img.shields.io/coveralls/VovanR/toggle-in-array.svg?style=flat-square