# @irony0901/toolbox

> basic utility functions

Latest version **0.8.7** (published 2022-10-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @irony0901/toolbox
pnpm add @irony0901/toolbox
yarn add @irony0901/toolbox
bun add @irony0901/toolbox
```

## Health

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

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

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.8.7 |
| Published | 2022-10-07 |
| First published | 2022-06-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 303.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | irony19 |
| Maintainers | irony19 |
| Keywords | deep, deep object, for each, repeat, clone, compare, filter, map, irony, select |

## Links

- npm: https://www.npmjs.com/package/@irony0901/toolbox
- Repository: https://github.com/irony1090/irony-toolbox
- Homepage: https://github.com/irony1090/irony-toolbox#readme
- Issues: https://github.com/irony1090/irony-toolbox/issues
- npm.io page: https://npm.io/package/@irony0901/toolbox

## Dependencies (1)

- [@irony0901/format](https://npm.io/package/@irony0901/format.md) ^0.1.3

## Recent versions

- 0.8.7 (latest) — 2022-10-07
- 0.8.6 — 2022-08-16
- 0.8.5 — 2022-08-16
- 0.8.4 — 2022-08-16
- 0.8.3 — 2022-08-01
- 0.8.3-dev — 2022-08-01
- 0.8.2 — 2022-08-01
- 0.8.1 — 2022-08-01
- 0.8.0 — 2022-07-21
- 0.7.5-a — 2022-07-11
- 0.7.5 — 2022-07-11
- 0.7.4 — 2022-06-21
- 0.7.3 — 2022-06-21
- 0.7.2 — 2022-06-21
- 0.7.1 — 2022-06-21
- … 1 more at https://npm.io/package/@irony0901/toolbox/versions

## README

## irony Toolbox
---
### My collection of useful JavaScript utilities.
## Features
* Typescript
* Steady update

# Download
To install ironyToolbox, use yarn
```
$ yarn add @irony0901/toolbox
```
## Methods
* [deepSelectFlatMap](#deepSelectFlatMap)
* [filterVariable](#filterVariable)
* [isContains](#isContains)
* [deepClone](#deepClone)
* [filterDuplication](#filterDuplication)
* [deepForEach](#deepForEach)
* [splitToObject](#splitToObject)
* [getIdsRecord](#getIdsRecord)
* [initBoolean](#initBoolean)

## deepSelectFlatMap
### deepSelectFlatMap(object: any, absoluteKey: string, predict: (param: LocationInfo) => any)
#### Parameter
- object: any
- absoluteKey: string   
  The path you want. separated by '.' **.**   
  Except for the path of the array, only enter the field name of the object.
- predict: (param: LocationInfo) => any   
  **LocationInfo**
  * root: Root of the object   
  * absoluteKeys: Path from the root. Array form   
  * absoluteKey: Path from the root. string form   
  * wrapper: Direct parent   
  * fieldName: field name within direct parent   
  * field: The value you want   

**Examples**
``` javascript
import { deepSelectFlatMap } from '@irony0901/toolbox';

const object = {
  persons: [
    { name: "aName" },
    { 
      name: "bName", 
      histories: [
        { 
          title: 'first job of b',
          keywords: [ 'game', 'social', 'study' ] 
        },
        { 
          title: 'experience of b',
          keywords: [ 'climbing', 'execise', 'positive' ] 
        }
      ]
    },
    { 
      name: "cName", 
      histories: [
        { 
          title: 'c is empty',
          keywords: undefined
        }
      ]
    },
    { 
      name: "dName", 
      histories: [
        { 
          title: 'umm... d is....', 
          keywords: [ 'Unemployed', 'effort', 'selfSatisfaction' ] 
        }
      ]
    }
  ],
  type: "category1"
}

deepSelectFlatMap(anyObject, 'persons.name', ({ fieldName, field }) => {
  console.log(fieldName, field)
})
/**
 * name aName
 * name bName
 * name cName
 * name dName
**/

deepSelectFlatMap(anyObject, 'persons.histories', ({ fieldName, field }) => {
  console.log(fieldName, field)
})
/**
 * 0 { title: 'first job of b', keywords: [ 'game', 'social', 'study' ] }
 * 
 * 1 {
 *   title: 'experience of b',
 *   keywords: [ 'climbing', 'execise', 'positive' ]
 * }
 * 
 * 0 { title: 'c is empty', keywords: undefined }
 * 
 * 0 {
 *   title: 'umm... d is....',
 *   keywords: [ 'Unemployed', 'effort', 'selfSatisfaction' ]
 * }
**/

deepSelectFlatMap(anyObject, 'persons.histories.keywords', ({ fieldName, field }) => {
  console.log(fieldName, field)
})
/**
 * 0 game
 * 1 social
 * 2 study
 * 0 climbing
 * 1 execise
 * 2 positive
 * 0 Unemployed
 * 1 effort
 * 2 selfSatisfaction
 * 
**/

```


## filterVariable
### filterVariable(origin, variable)
**Examples1**
``` javascript
import { filterVariable } from '@irony0901/toolbox';

const origin = {
  name: 'irony',
  age: 0,
  gender: 'male'
};
const variable = {
  age: null,
  gender: 'male'
};
const variable2 = {
  name: 'Irony',
  age: undefined,
  gender: 'female'
}
const variables1 = filterVariable(origin, variable);
const variables2 = filterVariable(origin, variable2);

console.log( '[variables1]', variables1 ) // '[variables1]' { age: null }
console.log( '[variables2]', variables2 ) // '[variables2]' { name: 'Irony', gender: 'female' }
```   

**Examples2**
``` javascript
import { filterVariable } from '@irony0901/toolbox';

const origin = {
  arrs: [ 1, 2, 3 ],
  obj: {
    id: 1,
    title: 'obj title'
  }
};
const variable = {
  arrs: [ 1, 3, 2 ],
  obj: {
    title: 'obj title',
    id: 1
  }
};
const variable2 = {
  arrs: [ 1, 2, 3 ],
  obj: {
    id: 1
  }
}
const variables1 = filterVariable(origin, variable);
const variables2 = filterVariable(origin, variable2);

console.log( '[variables1]', variables1 ) // '[variables1]' { arrs: [ 1, 3, 2 ] }
console.log( '[variables2]', variables2 ) // '[variables2]' { obj: { id: 1 } }
```   

## isContains
### isContains(subject, compare)
**Examples**
``` javascript
import { isContains } from '@irony0901/toolbox';

const subjectIrony = {
  id: 1,
  gender: 'male',
  name: 'irony',
};
const subjectFakeIrony = {
  id: 1,
  gender: 'other',
  name: 'fakeIrony'
};
const compare = { id: 1 };
const compare2 = { id: 1, gender: 'male' };

console.log( isContains(subjectIrony, compare) )      // true
console.log( isContains(subjectFakeIrony, compare) )  // true
console.log( isContains(subjectIrony, compare2) )     // true
console.log( isContains(subjectFakeIrony, compare2) ) // false
```   

## deepClone
### deepClone(object)
**Examples**
```javascript
import { deepClone } from '@irony0901/toolbox';

const object = {
  id: 1,
  title: 'title of object',
  category: {
    id: 'ctg-1',
    categoryTitle: 'category title',
    regDate: new Date(0)
  },
  regDate: new Date(0)
}

console.log( JSON.parse(JSON.stringify(object)) ) 
/** 
 * {
 *    id: 1,
 *    title: 'title of object',
 *    category: {
 *      id: ctg-1,
 *      categoryTitle: 'category title',
 *      regDate: '1970-01-01T00:00:00.000Z' // => **type is string**
 *    },
 *    regDate: '1970-01-01T00:00:00.000Z' // => **type is string**
 * }
 **/
console.log( deepClone(object) ) 
/** 
 * {
 *    id: 1,
 *    title: 'title of object',
 *    category: {
 *      id: ctg-1,
 *      categoryTitle: 'category title',
 *      regDate: 1970-01-01T00:00:00.000Z // => **type is Date**
 *    },
 *    regDate: 1970-01-01T00:00:00.000Z // => **type is Date**
 * }
 **/
```   

## filterDuplication
### filterDuplication(arr, keyOrKeys?)

#### filterDuplication(arr)
**Examples1**
```javascript
import { filterDuplication } from '@irony0901/toolbox';

const arr = [
  { id: 1, site: 'google'},
  { id: 2, site: 'yahoo'},
  { id: 3, site: 'reddit'},
  { id: 1, site: 'google'},
  { id: 1, site: 'google', type: 'search'},
  { id: 2, site: 'yahoo'},
  { id: 3, site: 'reddit'}
]

console.log( filterDuplication(arr) )
/**
 * [
 *    { id: 1, site: 'google'},
 *    { id: 2, site: 'yahoo'},
 *    { id: 3, site: 'reddit'},
 *    { id: 1, site: 'google', type: 'search'},
 * ]
**/
```

#### filterDuplication(arr, key)
**Examples2**
```javascript
import { filterDuplication } from '@irony0901/toolbox';

const arr = [
  { id: 1, site: 'google', type: 'search', ord: 1},
  { id: 2, site: 'yahoo', type: 'search', ord: 2},
  { id: 3, site: 'reddit', type: 'community', ord: 3},
  { id: 4, site: 'stackOverflow', type: 'search', ord: 4},
  { id: 5, site: 'GOOGLE', type: 'search', ord: 5},
  { id: 6, site: 'reddit', type: 'community', ord: 6},
  { id: 4, site: 'sTACKoVERFLOW', type: 'search', ord: 7},
  { id: 2, site: 'yahoo', type: 'search', ord: 8 }
]

console.log( filterDuplication(arr, 'id') )
/**
 * [
 *   { id: 1, site: 'google', type: 'search', ord: 1 },
 *   { id: 2, site: 'yahoo', type: 'search', ord: 2 },
 *   { id: 3, site: 'reddit', type: 'community', ord: 3 },
 *   { id: 4, site: 'stackOverflow', type: 'search', ord: 4 },
 *   { id: 5, site: 'GOOGLE', type: 'search', ord: 5 },
 *   { id: 6, site: 'reddit', type: 'community', ord: 6 }
 * ]
**/

console.log( filterDuplication(arr, 'site') )
/**
 * [
 *  { id: 1, site: 'google', type: 'search', ord: 1 },
 *  { id: 2, site: 'yahoo', type: 'search', ord: 2 },
 *  { id: 3, site: 'reddit', type: 'community', ord: 3 },
 *  { id: 4, site: 'stackOverflow', type: 'search', ord: 4 },
 *  { id: 5, site: 'GOOGLE', type: 'search', ord: 5 },
 *  { id: 4, site: 'sTACKoVERFLOW', type: 'search', ord: 7 }
 * ]
**/
```

#### filterDuplication(arr, keys)
**Examples3**
```javascript
import { filterDuplication } from '@irony0901/toolbox';

const arr = [
  { id: 1, site: 'google', type: 'search', ord: 1 },
  { id: 2, site: 'yahoo', type: 'search', ord: 2 },
  { id: 3, site: 'reddit', type: 'community', ord: 3 },
  { id: 4, site: 'stackOverflow', type: 'search', ord: 4 },
  { id: 5, site: 'GOOGLE', type: 'search', ord: 5 },
  { id: 6, site: 'reddit', type: 'community', ord: 6 },
  { id: 4, site: 'sTACKoVERFLOW', type: 'search', ord: 7 },
  { id: 2, site: 'yahoo', type: 'search', ord: 8 },

]

console.log( filterDuplication(arr, ['id', 'site']) )
/**
 * [
 *  { id: 1, site: 'google', type: 'search', ord: 1 },
 *  { id: 2, site: 'yahoo', type: 'search', ord: 2 },
 *  { id: 3, site: 'reddit', type: 'community', ord: 3 },
 *  { id: 4, site: 'stackOverflow', type: 'search', ord: 4 },
 *  { id: 5, site: 'GOOGLE', type: 'search', ord: 5 },
 *  { id: 6, site: 'reddit', type: 'community', ord: 6 },
 *  { id: 4, site: 'sTACKoVERFLOW', type: 'search', ord: 7 }
 * ]
**/

console.log( filterDuplication(arr, ['id', 'site', 'ord']) )
/**
 * [
 *  { id: 1, site: 'google', type: 'search', ord: 1 },
 *  { id: 2, site: 'yahoo', type: 'search', ord: 2 },
 *  { id: 3, site: 'reddit', type: 'community', ord: 3 },
 *  { id: 4, site: 'stackOverflow', type: 'search', ord: 4 },
 *  { id: 5, site: 'GOOGLE', type: 'search', ord: 5 },
 *  { id: 6, site: 'reddit', type: 'community', ord: 6 },
 *  { id: 4, site: 'sTACKoVERFLOW', type: 'search', ord: 7 },
 *  { id: 2, site: 'yahoo', type: 'search', ord: 8 }
 * ]
 */
```   

## deepForEach
### deepForEach(object, predict: (key: string|number, value: any, wrap: any) => any)
**Examples**
```javascript
import { deepForEach } from '@irony0901/toolbox';

const obj = {
  id: 'obj-1',
  arrs: [ 1, 2, 3 ],
  innerObj: {
    innerId: 1,
    innerTitle: 'obj title'
  },
  title: 'obj title',
  regDate: new Date(0)
};

deepForEach( obj, (key, val, wrap) => {
  console.log(`${key}:`, val, wrap)
  /**
   *  id: obj-1 {
   *    id: 'obj-1',
   *    arrs: [ 1, 2, 3 ],
   *    innerObj: { innerId: 1, innerTitle: 'obj title' },
   *    title: 'obj title',
   *    regDate: 1970-01-01T00:00:00.000Z
   *  }
   * 
   *  0: 1 [ 1, 2, 3 ]
   * 
   *  1: 2 [ 1, 2, 3 ]
   * 
   *  2: 3 [ 1, 2, 3 ]
   * 
   *  innerId: 1 { innerId: 1, innerTitle: 'obj title' }
   * 
   *  innerTitle: obj title { innerId: 1, innerTitle: 'obj title' }
   * 
   *  title: obj title {
   *    id: 'obj-1',
   *    arrs: [ 1, 2, 3 ],
   *    innerObj: { innerId: 1, innerTitle: 'obj title' },
   *    title: 'obj title',
   *    regDate: 1970-01-01T00:00:00.000Z
   *  }
   * 
   *  regDate: 1970-01-01T00:00:00.000Z {
   *    id: 'obj-1',
   *    arrs: [ 1, 2, 3 ],
   *    innerObj: { innerId: 1, innerTitle: 'obj title' },
   *    title: 'obj title',
   *    regDate: 1970-01-01T00:00:00.000Z
   *  }
  **/
})

```

## splitToObject
### splitToObject(object: any, keys: Array<keyof object>, option?)
#### Parameter
- object: any
- keys: Array<string>
- option?: SplitToObjectOptions & Partial{ [K in keyof object]: string }
  
**Examples**
```javascript
import { splitToObject } from '@irony0901/toolbox';

const orderByString = 'id-DESC';
const orderByString2 = 'id';
const orderByString3 = 'id:primary';
const result = splitToObject(orderByString, ['column', 'orderBy']);
const result2 = splitToObject(orderByString, ['name1', 'name2']);
const result3 = splitToObject(orderByString2, ['column', 'orderBy']);
const result4 = splitToObject(
  orderByString2, 
  [ 'column', 'orderBy' ], 
  { def: { column: 'id', orderBy: 'ASC' } } 
);
const result5 = splitToObject(
  orderByString3, 
  [ 'column', 'type' ], 
  { separator: ':' } 
);
console.log( result );  // { column: 'id', orderBy: 'DESC' }
console.log( result2 ); // { name1: 'id', name2: 'DESC' }
console.log( result3 ); // { column: 'id', orderBy: undefined }
console.log( result4 ); // { column: 'id', orderBy: 'ASC' }    
console.log( result5 ); // { column: 'id', type: 'primary' }   
```   

## getIdsRecord
### getIdsRecord( entities: Array<any>, keys: Array<string> )
**Examples**
```javascript
import { getIdsRecord } from '@irony0901/toolbox';

const entities = [
  { id: 1, city: 'aArea', name: 'Aname', gender: 'M' },
  { id: 2, city: 'aArea', name: 'Bname', gender: 'F' },
  { id: 3, city: 'bArea', name: 'Cname', gender: 'F' },
  { id: 4, city: 'cArea', name: 'Dname', gender: 'M' },
]

const result1 = getIdsRecord(entities, ['city'])
/** {
 *    city: [ 'aArea', 'bArea', 'cArea' ]
 *  } 
**/

const result2 = getIdsRecord(entities, ['gender'])
/** {
 *    gender: [ 'M', 'F' ]
 *  } 
**/

const result3 = getIdsRecord(entities, ['city', 'gender'])
/** {
 *    city: [ 'aArea', 'bArea', 'cArea' ],
 *    gender: [ 'M', 'F' ]
 *  } 
**/

const result4 = getIdsRecord(entities, ['id', 'city', 'name', 'gender'])
/** {
 *    id: [ 1, 2, 3, 4 ],
 *    city: [ 'aArea', 'bArea', 'cArea' ],
 *    name: [ 'Aname', 'Bname', 'Cname', 'Dname' ],
 *    gender: [ 'M', 'F' ]
 *  } 
**/
```

## initBoolean
### initBoolean(object: any)
**Examples**
```javascript
import { initBoolean } from '@irony0901/toolbox';

console.log(`undefined is ${initBoolean(undefined)}`) // false
console.log(`null is ${initBoolean(null)}`) // false
console.log(`true is ${initBoolean(true)}`) // true
console.log(`false is ${initBoolean(false)}`) // false
console.log(`1 is ${initBoolean(1)}`) // true
console.log(`-1 is ${initBoolean(-1)}`) // false
console.log(`0 is ${initBoolean(0)}`) // false
console.log(`'a' is ${initBoolean('a')}`) // false
console.log(`'true' is ${initBoolean('true')}`) // true
console.log(`'on' is ${initBoolean('on')}`) // true
console.log(`'yes' is ${initBoolean('yes')}`) // true
```
## License
[MIT](LICENSE)

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