omer73364 / toggle-item-in-array

A JavaScript package to toggle a value in an array with an optional validation function

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

toggle-item-in-array

A JavaScript package to toggle a value in an array with an optional validation function

toggle function adds or removes a value from an array

it accepts three parameters:

  1. an array
  2. a value
  3. a funcion to validate the value (optional parameter)

if the array actually includes the value then it removes the value from the array if not then it adds the value to the array

usage:

NPM:

  download this library:
  
    npm i toggle-item-in-array --save
    
    
  then import it:
  
    import { toggle } from 'toggle-item-in-array';
    
    
  then you can use it as a function by "toggle" name

HTML:

  include the library in your html page
  
    <script src="https://unpkg.com/toggle-item-in-array@1.0.1/toggle-item-in-array.js"></script>
    
    
  then you can use it as a function by "toggle" name

example:

  let arr = [12]
  
  toggle(arr,5) // will add 5 to arr
  console.log(arr) // [12,5]
  
  toggle(arr,12) // will remove 12 from arr
  console.log(arr) // [5]
  
  toggle(arr,'bad',(v)=>v!=='bad') // will not add because the value is not valid
  console.log(arr) // [5]

About

A JavaScript package to toggle a value in an array with an optional validation function


Languages

Language:JavaScript 100.0%