toggle-array

1.0.1 • Public • Published

toggle-array NPM version NPM monthly downloads NPM total downloads Linux Build Status

In an array of objects, this enables a property on the object at the specified index, while disabling the property on all other objects.

Install

Install with npm:

$ npm install --save toggle-array

Usage

var toggle = require('toggle-array');
var arr = [
  {foo: true},
  {foo: true},
  {foo: true},
  {foo: true},
  {foo: true}
];
 
console.log(toggle(arr, 'foo', 2));
// [ { foo: true },
//   { foo: false },
//   { foo: true },
//   { foo: true },
//   { foo: true } ]
 
console.log(toggle(arr, 'foo', 2));
// [ { foo: false },
//   { foo: true },
//   { foo: false },
//   { foo: false },
//   { foo: false } ]

.enable

Enables the element at the given index, and disables all other items:

var toggle = require('toggle-array');
var arr = [
  {foo: true},
  {foo: true},
  {foo: true},
  {foo: true},
  {foo: true}
];
 
console.log(toggle.enable(arr, 'foo', 2));
// [ { foo: false },
//   { foo: false },
//   { foo: true },
//   { foo: false },
//   { foo: false } ]

.disable

Disabled the element at the given index, and enables all other items:

var toggle = require('toggle-array');
var arr = [
  {foo: false},
  {foo: false},
  {foo: false},
  {foo: false},
  {foo: false}
];
 
console.log(toggle.disable(arr, 'foo', 2));
// [ { foo: true },
//   { foo: true },
//   { foo: false },
//   { foo: true },
//   { foo: true } ]

About

Related projects

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.


This file was generated by verb-generate-readme, v0.6.0, on May 07, 2017.

Readme

Keywords

Package Sidebar

Install

npm i toggle-array

Weekly Downloads

41,272

Version

1.0.1

License

MIT

Last publish

Collaborators

  • jonschlinkert