Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kamataryo/extypes
https://github.com/kamataryo/extypes
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/kamataryo/extypes
- Owner: kamataryo
- Created: 2017-05-24T02:50:14.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-01-27T00:02:29.000Z (almost 7 years ago)
- Last Synced: 2024-11-09T10:48:42.398Z (about 2 months ago)
- Language: JavaScript
- Size: 175 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @kamataryo/extypes
[](https://travis-ci.org/kamataryo/extypes)
[](https://ci.appveyor.com/project/kamataryo/extypes)
[](https://codeclimate.com/github/kamataryo/extypes)
[](https://codecov.io/gh/kamataryo/extypes)
[](https://www.npmjs.com/package/@kamataryo/extypes)
[](https://david-dm.org/@kamataryo/extypes#info=devDependencies)
[](https://david-dm.org/@kamataryo/extypes)
[](https://david-dm.org/kamataryo/extypes#info=devDependencies)
[](https://opensource.org/licenses/MIT)
Light and safe JavaScript Data type extensions.
## features
- collision free with `Symbol` property.
- Partial import is Available. This saves file size when bundled
## install
```shell
$ npm install @kamataryo/extypes --save-dev
```
## usage
```javascript
// import all
import props from '@kamataryo/extypes'
console.log([0, 1, 2][props.Array.$random]) // 0, 1, or 2
// partial import on a certain type
import props, { $random } from '@kamataryo/extypes/Array'
console.log([0, 1, 2][props.$random]) // 0, 1, or 2
console.log([0, 1, 2][$random]) // 0, 1, or 2
// partial import on a certain property/method
import $radom from '@kamataryo/extypes/Array/$random'
console.log([0, 1, 2][$random]) // 0, 1, or 2
```
## APIs
### Object
#### `Object[$dig](props, fallback)`
Dig nested properties.
```javascript
{ a : { b : { c : 'd' } } }[$dig](['a', 'b', 'c']) // 'd'
{ a : { b : { c : 'd' } } }[$dig](['a', 'X'], 'no props') // 'no props'
```
#### `Object[$keys]`
Wrapper of `Object.keys`.
```javascript
{ foo: 'FOO', bar: 'BAR' }[$keys] // ['foo', 'bar']
```
#### `Object[$multiply]()`
```javascript
{ a: 'A' }[$multiply](3) // [{ a: 'A' }, { a: 'A' }, { a: 'A' }]
```
#### `Object[$values]`
Wrapper of `Object.values`.
```javascript
{ foo: 'FOO', bar: 'BAR' }[$values] // ['FOO', 'BAR']
```
#### `Object[$switch]`
Wrapper of [switz](https://www.npmjs.com/package/switz).
```javascript
'abc'[$switch]
.case('ABC', () => console.log('not match'))
.case('abc', () => console.log('match!'))
.default(() => console.log('not match'))
// 'match!'
```
### Array
#### `Array[$cummulatives]`
get cummulative values of the array.
```javascript
[1, 10, 100][$cummulative] // [1, 11, 111]
```
#### `Array[$flatten]()`
Flatten array.
```javascript
[[0, 1], [2], 3][$flatten]() // [0, 1, 2, 3]
```
#### `Array[$push](any)`
Non-destructive altenative method for `Array.push`.
```javascript
[0, 1, 2][$push](3) // [0, 1, 2, 3]
```
#### `Array[$random]`
Pick an element randomly.
```javascript
[0, 1, 2][$random] // 0, 1, or 2
```
#### `Array[$weightedRandom](array)`
Pick an element randomly and weightedly.
```javascript
[0, 1, 2][$weightedRandom]([1, 1, 2]) // 0(25%), 1(25%) or 2(50%)
```
### Function
#### `Function[$partialApply](...args)`
Curry the function.
```javascript
((a, b, c) => a + b + c)[$partialApply](1) // (b + c) => 1 + b + c
```
#### `Function[$appliedArguments]`
Applied argument after curried.
```javascript
((a, b, c) => a + b + c)[$partialApply](1, 2)[$appliedArguments] // [1, 2]
```
#### `Function[$repeat](args, num)`
Call function repeatedly.
```javascript
((a, b, c) => a + b + c)[$repeat]([1, 2, 3], 2) // [6, 6]
```
### Number
#### `Number[$toRange]()`
Create range array.
```javascript
100[$toRange]() // [0, 1, ... ,99]
```
#### `Number[$zeroPadding](int, dec)`
Create zero padding string.
```javascript
123[$zeroPadding](5) // '00123'
1.23[$zeroPadding](false, 3) // '1.230'
12.3[$zeroPadding](3, 3) // '012.300'
```
## initialize deploy secrets (for commiters)
Below initializes..
- encrypted npm deploy token
- encrypted GitHub deploy key
and send new private key to the concerned remote repository.
```shell
$ .bin/travis-setup.sh kamataryo/extypes
```
## deployment (for commiters)
```shell
$ npm version patch -m "some patch"
$ npm version minor -m "some minor update"
$ npm version major -m "some major update"
```
## TODOs
- check performance
- invalid arguments
- How to deal with Lodash/Underscore?