open-index/open-npm huggingface dataset:
npm package: @micro-js/is-function
Description: Test whether a given value is a function.
Latest version: 1.0.4


# is-function

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Test whether a given value is a function.

## Installation

    $ npm install @micro-js/is-function

## Usage

```js
var isFunction = require('@micro-js/is-function')

isFunction() // => false
isFunction(true) // => false
isFunction({}) // => false
isFunction(function () {}) // => true
```

## API

### isFunction(value)

- `value` - value to test

**Returns:** boolean

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/is-function.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/is-function
[git-image]: https://img.shields.io/github/tag/micro-js/is-function.svg
[git-url]: https://github.com/micro-js/is-function
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/is-function.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/is-function
npm package: @micro-js/is-generator
Description: Check if generator.
Latest version: 1.1.1


# is-generator

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Check if generator.

## Installation

    $ npm install @micro-js/is-generator

## Usage

```js
var isGenerator = require('@micro-js/is-generator')

isGenerator(function * () {
  yield 1
}) // => true
```

## API

### isGenerator(obj)

- `obj` - object to test

**Returns:** boolean

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/is-generator.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/is-generator
[git-image]: https://img.shields.io/github/tag/micro-js/is-generator.svg
[git-url]: https://github.com/micro-js/is-generator
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/is-generator.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/is-generator
npm package: @micro-js/is-generator-function
Description: Check if generator function.
Latest version: 1.0.0


# is-generator-function

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Check if generator function.

## Installation

    $ npm install @micro-js/is-generator-function

## Usage

```js
var isGeneratorFunction = require('@micro-js/is-generator-function')

isGeneratorFunction(function * () {
  yield 1
}) // => true
```

## API

### isGeneratorFunction(obj)

- `obj` - object to test

**Returns:** boolean

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/is-generator-function.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/is-generator-function
[git-image]: https://img.shields.io/github/tag/micro-js/is-generator-function.svg
[git-url]: https://github.com/micro-js/is-generator-function
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/is-generator-function.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/is-generator-function
npm package: @micro-js/is-generator-object
Description: Check if generator object.
Latest version: 1.1.0


# is-generator-object

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Check if generator object.

## Installation

    $ npm install @micro-js/is-generator-object

## Usage

```js
var isGeneratorObject = require('@micro-js/is-generator-object')

isGeneratorObject(function * () {
  yield 1
}()) // => true

```

## API

### isGeneratorObject(obj)

- `obj` - object to test

**Returns:** boolean

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/is-generator-object.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/is-generator-object
[git-image]: https://img.shields.io/github/tag/micro-js/is-generator-object.svg
[git-url]: https://github.com/micro-js/is-generator-object
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/is-generator-object.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/is-generator-object
npm package: @micro-js/is-number
Description: Check if a value is a number
Latest version: 1.0.0


# is-number

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Check if a value is a number

## Installation

    $ npm install @micro-js/is-number

## Usage

```js
var isNumber = require('@micro-js/is-number')

isNumber(1)
isNumber(NaN)
!isNumber('test')
!isNumber('10')

```

## API

### isNumber(value)

- `value` - The value to be checked for numberness

**Returns:** Boolean value indicating whether or not `value` is a number.

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/is-number.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/is-number
[git-image]: https://img.shields.io/github/tag/micro-js/is-number.svg
[git-url]: https://github.com/micro-js/is-number
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/is-number.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/is-number
npm package: @micro-js/is-object
Description: Check if plain object.
Latest version: 1.0.0


# is-object

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Check if plain object.

## Installation

    $ npm install @micro-js/is-object

## Usage

```js
var isObject = require('@micro-js/is-object')

isObject({}) // true
```

## API

### isObject(obj)

- `obj` - object to test

**Returns:** boolean

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/is-object.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/is-object
[git-image]: https://img.shields.io/github/tag/micro-js/is-object.svg
[git-url]: https://github.com/micro-js/is-object
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/is-object.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/is-object
npm package: @micro-js/is-promise
Description: Check whether a value is a promise.
Latest version: 1.0.0


# is-promise

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Check whether a value is a promise.

## Installation

    $ npm install @micro-js/is-promise

## Usage

```js
var isPromise = require('@micro-js/is-promise');

isPromise({then: function () {...}}) // => true
isPromise(null) // => false
isPromise({}) // => false
isPromise({then: true})// => false
```

## API

### isPromise(value)

- `value` - value to test

**Returns:** boolean


## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/is-promise.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/is-promise
[git-image]: https://img.shields.io/github/tag/micro-js/is-promise.svg
[git-url]: https://github.com/micro-js/is-promise
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/is-promise.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/is-promise
npm package: @micro-js/is-string
Description: Check if string.
Latest version: 1.0.1


# is-string

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Check if string.

## Installation

    $ npm install @micro-js/is-string

## Usage

```js
var isString = require('@micro-js/is-string')

isString('foo') // => true
```

## API

### isString(value)

- `value` - value to test

**Returns:** boolean

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/is-string.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/is-string
[git-image]: https://img.shields.io/github/tag/micro-js/is-string.svg
[git-url]: https://github.com/micro-js/is-string
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/is-string.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/is-string
npm package: @micro-js/is-undefined
Description: Check if undefined.
Latest version: 1.0.0


# is-undefined

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Check if undefined.

## Installation

    $ npm install @micro-js/is-undefined

## Usage

```js
var isUndefined = require('@micro-js/is-undefined')

isUndefined(undefined) // => true
```

## API

### isUndefined(value)

- `value` - value to check

**Returns:** boolean

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/is-undefined.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/is-undefined
[git-image]: https://img.shields.io/github/tag/micro-js/is-undefined.svg
[git-url]: https://github.com/micro-js/is-undefined
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/is-undefined.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/is-undefined
npm package: @micro-js/keychord
Description: Takes in a keypress/keydown/keyup event and returns a chord striE.g. &#x27;ctrl+shift+t&#x27;
Latest version: 1.0.0


# keychord

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Takes in a keypress/keydown/keyup event and returns a chord striE.g. &#x27;ctrl+shift+t&#x27;

## Installation

    $ npm install @micro-js/keychord

## Usage

```js
var keychord = require('@micro-js/keychord')

function render () {
  return <div onKeypress={handleKeypress} />
}

function handleKeypress (e) {
  switch (keychord(e)) {
    case 'enter':
      // handle enter
      break
    case 'shift+enter':
      // handle shift+enter
      break
    case 'ctrl+up':
      // handle ctrl+up
      break
  }
}
```

## API

### keychord(event)

- `event` - A (https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent)[KeyboardEvent] as in keypress/keyup/keydown.

**Returns:** A keychord string. If only one key is being pressed, just returns the name of that key. If it is a sequence of keys, returns a string of the form 'ctrl+shift+enter'.

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/keychord.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/keychord
[git-image]: https://img.shields.io/github/tag/micro-js/keychord.svg
[git-url]: https://github.com/micro-js/keychord
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/keychord.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/keychord
npm package: @micro-js/keycodes
Description: Map of keycodes to human readable key names
Latest version: 1.0.1


# keycodes

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Map of keycodes to human readable key names

## Installation

    $ npm install @micro-js/keycodes

## Usage

Keycodes exports this:

```javascript
var keycodes = {
  8: 'backspace',
  9: 'tab',
  13: 'enter',
  16: 'shift',
  17: 'ctrl',
  18: 'alt',
  19: 'pause',
  20: 'caps_lock',
  27: 'esc',
  32: 'space',
  33: 'page_up',
  34: 'page_down',
  35: 'end',
  36: 'home',
  37: 'left',
  38: 'up',
  39: 'right',
  40: 'down',
  45: 'insert',
  46: 'delete',
  91: 'command',
  93: 'right_click',
  106: 'numpad_*',
  107: 'numpad_+',
  109: 'numpad_-',
  110: 'numpad_.',
  111: 'numpad_/',
  144: 'num_lock',
  145: 'scroll_lock',
  182: 'my_computer',
  183: 'my_calculator',
  186: ';',
  187: '=',
  188: ',',
  189: '-',
  190: '.',
  191: '/',
  192: '`',
  219: '[',
  220: '\\',
  221: ']',
  222: "'"
}
```

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/keycodes.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/keycodes
[git-image]: https://img.shields.io/github/tag/micro-js/keycodes.svg
[git-url]: https://github.com/micro-js/keycodes
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/keycodes.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/keycodes
npm package: @micro-js/map
Description: Map a function over a container of some kind
Latest version: 1.1.0


# map

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Map a function over a container of some kind

## Installation

    $ npm install @micro-js/map

## Usage

```js
var map = require('@micro-js/map')

map(add1, [1, 2, 3])          // -> [2, 3, 4]
map(add1, {a: 1, b: 2, c: 3}) // -> {a: 2, b: 3, c: 4}

function add1 (n) {
  return n + 1
}
```

## API

### map(fn, container)

- `fn` - The function to map over val. Accepts `(val, key)` and returns a new `val` to be set at `key`.
- `container` - A container of some kind (objects or arrays at the moment, generators soon too).

**Returns:** A new entity of the same type as `container` with all of its values being replaced by the result of `fn(val, key)`.

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/map.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/map
[git-image]: https://img.shields.io/github/tag/micro-js/map.svg
[git-url]: https://github.com/micro-js/map
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/map.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/map
npm package: @micro-js/map-array
Description: Map array.
Latest version: 1.1.0


# map-array

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Map array.

## Installation

    $ npm install @micro-js/map-array

## Usage

```js
var map = require('@micro-js/map-array')

map(addOne, [1, 2]) //  => [2, 3]

function addOne (v) {
  return v + 1
}

```

## API

### mapArray(fn, array)

- `fn` - mapping function
- `array` - array to map over

**Returns:** mapped array

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/map-array.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/map-array
[git-image]: https://img.shields.io/github/tag/micro-js/map-array.svg
[git-url]: https://github.com/micro-js/map-array
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/map-array.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/map-array
npm package: @micro-js/map-gen
Description: Map for generator.
Latest version: 1.4.1


# map-gen

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Map for generator.

## Installation

    $ npm install @micro-js/map-gen

## Usage

```js
var map = require('@micro-js/map-gen')

Array.from(map(addOne, function * () {
  yield 1
  yield 2
  yield 3
})) // [2, 3, 4]

function addOne(v) {
  return v + 1
}
```

## API

### mapGen(fn, gen)

- `fn` - mapping function
- `gen` - generates values to map

**Returns:** generator of mapped values

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/map-gen.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/map-gen
[git-image]: https://img.shields.io/github/tag/micro-js/map-gen.svg
[git-url]: https://github.com/micro-js/map-gen
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/map-gen.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/map-gen
npm package: @micro-js/map-obj
Description: Map for objects.
Latest version: 1.1.2


# map-obj

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Map for objects.

## Installation

    $ npm install @micro-js/map-obj

## Usage

```js
var mapObj = require('@micro-js/map-obj')

mapObj(addOne, {a: 1, b: 2}) // => {a: 2, b: 3}

function addOne (v) {
  return v + 1
}

```

## API

### mapObj(fn, obj)

- `fn` - map function
- `obj` - obj to map over

**Returns:** mapped object

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/map-obj.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/map-obj
[git-image]: https://img.shields.io/github/tag/micro-js/map-obj.svg
[git-url]: https://github.com/micro-js/map-obj
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/map-obj.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/map-obj
npm package: @micro-js/memoize
Description: Create a function that memoizes the result of a &#x60;fn&#x60;.
Latest version: 1.0.0


# memoize

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Create a function that memoizes the result of a &#x60;fn&#x60;.

## Installation

    $ npm install @micro-js/memoize

## Usage

```js
var memoize = require('@micro-js/memoize')

var slow = memoize(function (num) {
  var calc = 0
  for (var i = 0; i < num; ++i) {
    calc += i
  }
  return calc
})

// slow
slow(100) // => 4950

// fast
slow(100) // => 4950


```

## API

### memoize(fn)

- `fn` - a function to memoize

**Returns:** memoized function

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/memoize.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/memoize
[git-image]: https://img.shields.io/github/tag/micro-js/memoize.svg
[git-url]: https://github.com/micro-js/memoize
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/memoize.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/memoize
npm package: @micro-js/object-equal
Description: Shallow object equality check
Latest version: 1.0.0


# object-equal

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)

Shallow object equality check

## Installation

    $ npm install @micro-js/object-equal

## Usage

`objectEqual({a: 1}, {a: 1}) === true`
`objectEqual({a: 1}, {b: 1}) === false`

## License

The MIT License

Copyright &copy; 2015, Weo.io &lt;info@weo.io&gt;

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
npm package: @micro-js/object-to-promise
Description: Convert an object to a promise.
Latest version: 1.0.0


# object-to-promise

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Convert an object to a promise.

## Installation

    $ npm install @micro-js/object-to-promise

## Usage

```js
var objectToPromise = require('object-to-promise')

objectToPromise({
  1: Promise.resolve(1),
  2: Promise.resolve(2)
}).then(function (obj) {
  console.log(obj) // => { 1: 1, 2: 2 }
})

```

## API

### objectToPromise(object)

- `object` - an object of "resolavables"

**Returns:** a promise

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/object-to-promise.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/object-to-promise
[git-image]: https://img.shields.io/github/tag/micro-js/object-to-promise.svg
[git-url]: https://github.com/micro-js/object-to-promise
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/object-to-promise.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/object-to-promise
npm package: @micro-js/omit
Description: Simple, tiny object omit utility
Latest version: 2.0.0


# omit

Simple, tiny object omit utility

## Installation

    $ npm install @micro-js/omit

## Usage

`omit(obj, keys)`

  * `obj` - An object from which you'd like to omit some keys
  * `keys` - A single key, array of keys, or truth-test function for keys to omit
  * `ctx` - An optional context upon which to invoke `keys` if it is a function (this argument does nothing otherwise)

Returns a new object with `keys` omitted from it.

## License

The MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
npm package: @micro-js/omit-prop
Description: Non-destructively omit a nested property
Latest version: 1.0.0


# omit-prop

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Non-destructively omit a nested property

## Installation

    $ npm install @micro-js/omit-prop

## Usage

```js
var omitProp = require('@micro-js/omit-prop')

```

## API

### omitProp(arg)

- `arg` -

**Returns:**

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/omit-prop.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/omit-prop
[git-image]: https://img.shields.io/github/tag/micro-js/omit-prop.svg
[git-url]: https://github.com/micro-js/omit-prop
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/omit-prop.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/omit-prop
npm package: @micro-js/pick
Description: Return partial copy of object containing specified subset of keys.
Latest version: 1.0.1


# pick

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Return partial copy of object containing specified subset of keys.

## Installation

    $ npm install @micro-js/pick

## Usage

```js
var pick = require('@micro-js/pick')

var source = {a: 1, b: 2, c: 3}

pick(['a', 'c'], souce) // => {a: 1, c: 3}
```

## API

### pick(keys, obj)

- `keys` - keys to pick
- `obj` - source object to copy values from

**Returns:** partial copy of `obj`

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/pick.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/pick
[git-image]: https://img.shields.io/github/tag/micro-js/pick.svg
[git-url]: https://github.com/micro-js/pick
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/pick.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/pick
npm package: @micro-js/pick-as
Description: Return partial copy of object containing specified subset of aliased keys.
Latest version: 1.0.0


# pick-as

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Return partial copy of object containing specified subset of aliased keys.

## Installation

    $ npm install @micro-js/pick-as

## Usage

```js
var pickAs = require('@micro-js/pick-as')

var source = {a: {b: 2}, c: 3}
pickAs({d: 'a.b', e: 'c'}, source) // => {d: 2, e: 3}

```

## API

### pickAs(map, obj)

- `map` - A map of keys to pick to their new names
- `obj` - Source to copy

**Returns:** Partial copy of `obj` with aliased keys.

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/pick-as.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/pick-as
[git-image]: https://img.shields.io/github/tag/micro-js/pick-as.svg
[git-url]: https://github.com/micro-js/pick-as
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/pick-as.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/pick-as
npm package: @micro-js/reduce-filter
Description: Generates a reducer that filters its accumulator using a predicate derived from its value argument.
Latest version: 2.0.0


# reduce-filter

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Generates a reducer that filters its accumulator by reducing each of its items to a boolean value. That is somewhat complicated to state, but easy to read as code:

```javascript
function reduceFilter (fn) {
  return function (state, value) {
    return filter(predicate, state)

    function predicate (item, key) {
      return fn(item, value, key)
    }
  }
}

```

## Installation

    $ npm install @micro-js/reduce-filter

## Usage

```js
var reduceFilter = require('@micro-js/reduce-filter')

reduceFilter(isDivisbleBy)([1, 2, 3, 4, 5], 2) // -> [2, 4]

function isDivisbleBy (m, n) {
  return m % n === 0
}

```

## API

### reduceFilter(fn)

- `fn` - Accepts `(item, value, key)` and returns a bool, indicating whether or not to retain `item`.

**Returns:** Returns a reducing function that accepts `(state, value)` and returns a new container of type `state` filtered by `fn`.

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/reduce-filter.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/reduce-filter
[git-image]: https://img.shields.io/github/tag/micro-js/reduce-filter.svg
[git-url]: https://github.com/micro-js/reduce-filter
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/reduce-filter.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/reduce-filter
npm package: @micro-js/reduce-key
Description: Reduce a keyed map (or array), using a selector function.
Latest version: 1.0.2


# reduce-key

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Reduce a keyed map (or array), using a selector function.

## Installation

    $ npm install @micro-js/reduce-key

## Usage

One thing that often prevents the fully declarative construction of reducers is keyed maps (e.g. objects of the form `{[key]: entity}`, or arrays). reduceKey solves this problem, by allowing you to specify a selector function that decides which subject to apply the reducer to.


```js
var reduceKey = require('@micro-js/reduce-key')

const todoReducer = combineReducers({
  text: handleActions({
    [TODO_SET_TEXT]: (state, {text}) => text,
    [TODO_CLEAR_TEXT]: () => ''
  }),
  completed: handleActions({
    [TOGGLE_COMPLETED]: (state) => !state
  })
})

export default combineReducers({
  todos: reduceKey((state, {idx}) => idx, todoReducer)
})
```

## API

### reduceKey(select, reduce)

- `select` - A function that accepts state and action and returns the key. If `select` returns `null`, `undefined`, or `false`, the reducer will not be called. So you are free to do things like:
             `(state, action) => action.payload.key` - even if your actions do not always contain key.
- `reduce` - A reducer that reduces over the entities within the map or array.

**Returns:** A reducer that reduces over the sub-object in the key and returns a new copy of the map, with the sub-object specified by `select(state, action)` updated by your reducer.

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/reduce-key.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/reduce-key
[git-image]: https://img.shields.io/github/tag/micro-js/reduce-key.svg
[git-url]: https://github.com/micro-js/reduce-key
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/reduce-key.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/reduce-key
npm package: @micro-js/reduce-map
Description: Generates a reducing function that parameterizes a map iterator using the 2nd parameter to reduce.
Latest version: 2.0.0


# reduce-map

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Generates a reducing function that maps a reducer over the entities in a container (usually an object or array). That is complicated to state, but simple if you see the implementation:

```javascript
function reduceMap (fn) {
  return function (state, value) {
    return map(iter, state)

    function iter (item, key) {
      return fn(item, value, key)
    }
  }
}

```

## Installation

    $ npm install @micro-js/reduce-map

## Usage

```js
var reduceMap = require('@micro-js/reduce-map')

combineActions({
  todos: handleActions({
    [SET_ALL_COMPLETED]: reduceMap((todo, {completed}) => ({...todo, completed}))
  })
})
```

## API

### reduceMap(fn)

- `fn` - A function that accepts `(item, value, key)` and produces a new `item` based on `value`.

**Returns:** A reducing function that maps your reducer `fn`, over `state` to produce a new container of type `state` from each of its elements, and the value passed to reduce.

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/reduce-map.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/reduce-map
[git-image]: https://img.shields.io/github/tag/micro-js/reduce-map.svg
[git-url]: https://github.com/micro-js/reduce-map
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/reduce-map.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/reduce-map
npm package: @micro-js/reduce-replace
Description: A reducer that replaces the accumulator with the next value
Latest version: 1.0.0


# reduce-replace

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

A reducer that replaces the accumulator with the next value

## Installation

    $ npm install @micro-js/reduce-replace

## Usage

```js
var reduceReplace = require('@micro-js/reduce-replace')

const todoReducer = combineReducers({
  text: handleActions({
    [TODO_SET_TEXT]: reduceReplace({text} => text),
  })
})
```

## API

### reduceReplace(fn)

- `fn` - Transforms the 2nd parameter to reduce. Defaults to [https://github.com/micro-js/identity](identity).

**Returns:** A reducer that replaces the accumulator with the value returned by `fn(value)`.

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/reduce-replace.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/reduce-replace
[git-image]: https://img.shields.io/github/tag/micro-js/reduce-replace.svg
[git-url]: https://github.com/micro-js/reduce-replace
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/reduce-replace.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/reduce-replace
npm package: @micro-js/set-prop
Description: Non-destructively set a nested property, given its path
Latest version: 0.1.4


# set-prop

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Non-destructively set a nested property, given its path

## Installation

    $ npm install @micro-js/set-prop

## Usage

```js
var setProp = require('@micro-js/set-prop')
var obj = {a: {b: 1}}
var newObj = setProp('a.b', obj, 2)

obj.a.b === 1
newObj.a.b === 2
obj !== newObj

```

## API

### setProp(path, obj, value)

- `path` - The path (specified as array or dotted string) of the property you wish to set
- `obj` - The root object you want to set within
- `value` - The value you want to assign to `path` within `obj`

**Returns:** A new root `obj` that has `path` changed to `value`, and all of the sub-objects in its tree cloned as well.

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/set-prop.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/set-prop
[git-image]: https://img.shields.io/github/tag/micro-js/set-prop.svg
[git-url]: https://github.com/micro-js/set-prop
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/set-prop.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/set-prop
npm package: @micro-js/slice
Description: Shallow copy array or portion of array.
Latest version: 1.0.0


# slice

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Shallow copy of array or portion of array.

## Installation

    $ npm install @micro-js/slice

## Usage

```js
var slice = require('@micro-js/slice')

slice([1, 2], 1) // => 2
```

## API

### slice(array, begin, end)

- `array` - source array
- `begin` - beginning of copy
- `end` - end of copy

**Returns:** copy of array

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/slice.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/slice
[git-image]: https://img.shields.io/github/tag/micro-js/slice.svg
[git-url]: https://github.com/micro-js/slice
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/slice.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/slice
npm package: @micro-js/supports-gen
Description: Supports generator syntax.
Latest version: 1.1.0


# supports-gen

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Supports generator syntax.

## Installation

    $ npm install @micro-js/supports-gen

## Usage

```js
var supportsGen = require('@micro-js/supports-gen')
supportsGen() // => true or false
```

## API

### supportsGen()

**Returns:** boolean

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/supports-gen.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/supports-gen
[git-image]: https://img.shields.io/github/tag/micro-js/supports-gen.svg
[git-url]: https://github.com/micro-js/supports-gen
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/supports-gen.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/supports-gen
npm package: @micro-js/throttle-intervaled
Description: A throttle that only fires on an interval.
Latest version: 1.0.2


# throttle-intervaled

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

A throttle that only fires on an interval.

## Installation

    $ npm install @micro-js/throttle-intervaled

## Usage

```js
var throttle = require('@micro-js/throttle-intervaled')

var hello = throttle(500, function () {
  console.log('Hello world')
})

// will log "hello world" once, 500 ms from first call
hello()
hello()

```

## API

### throttleIntervaled(interval, fn)

- `interval` - interval
- `fn` - function to throttle

**Returns:** throttled `fn`

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/throttle-intervaled.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/throttle-intervaled
[git-image]: https://img.shields.io/github/tag/micro-js/throttle-intervaled.svg
[git-url]: https://github.com/micro-js/throttle-intervaled
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/throttle-intervaled.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/throttle-intervaled
npm package: @micro-js/thunk-to-promise
Description: Convert a thunk to a promise.
Latest version: 1.0.0


# thunk-to-promise

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Convert a thunk to a promise.

## Installation

    $ npm install @micro-js/thunk-to-promise

## Usage

```js
var thunkToPromise = require('@micro-js/thunk-to-promise')

thunkToPromise(function (cb) {
  cb(null, 1, 2)
}).then(function (res) {
  res // => [1, 2]
})

```

## Api

### thunkToPromise(thunk)

- `thunk` - thunk to convert

**Returns:** a promise

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/thunk-to-promise.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/thunk-to-promise
[git-image]: https://img.shields.io/github/tag/micro-js/thunk-to-promise.svg
[git-url]: https://github.com/micro-js/thunk-to-promise
[npm-image]: https://img.shields.io/npm/v/@micro-js/thunk-to-promise.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/thunk-to-promise
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
npm package: @micro-js/to-array
Description: Convert to array from array like.
Latest version: 1.0.0


# to-array

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Convert to array from array like.

## Installation

    $ npm install @micro-js/to-array

## Usage

```js
var toArray = require('@micro-js/to-array')

args(1, 2) // => [1, 2]

function args () {
  return toArray(arguments)
}

```

## API

### toArray(arr)

- `arr` - array like

**Returns:** array

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/to-array.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/to-array
[git-image]: https://img.shields.io/github/tag/micro-js/to-array.svg
[git-url]: https://github.com/micro-js/to-array
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/to-array.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/to-array
npm package: @micro-js/values
Description: Get the array of values for an object.
Latest version: 1.0.0


# values

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Get the array of values for an object.

## Installation

    $ npm install @micro-js/values

## Usage

```js
var values = require('@micro-js/values')

values({1: 1, 2: 2}) // [1, 2]
```

## API

### values(obj)

- `obj` - object to convert

**Returns:** values in `obj`

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/values.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/values
[git-image]: https://img.shields.io/github/tag/micro-js/values.svg
[git-url]: https://github.com/micro-js/values
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/values.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/values
npm package: @micro-js/zip-obj
Description: Create an object from a list of keys and values.
Latest version: 1.0.0


# zip-obj

[![Build status][travis-image]][travis-url]
[![Git tag][git-image]][git-url]
[![NPM version][npm-image]][npm-url]
[![Code style][standard-image]][standard-url]

Create an object from a list of keys and values.

## Installation

    $ npm install @micro-js/zip-obj

## Usage

```js
var zipObj = require('@micro-js/zip-obj')

zipObj([1, 2], [1, 2]) // => {1: 1, 2: 2}
```

## API

### zipObj(keys, values)

- `keys` - list of keys for new object
- `values` - list of values for new object

**Returns:** object with `keys` and `values`

## License

MIT

[travis-image]: https://img.shields.io/travis/micro-js/zip-obj.svg?style=flat-square
[travis-url]: https://travis-ci.org/micro-js/zip-obj
[git-image]: https://img.shields.io/github/tag/micro-js/zip-obj.svg
[git-url]: https://github.com/micro-js/zip-obj
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat
[standard-url]: https://github.com/feross/standard
[npm-image]: https://img.shields.io/npm/v/@micro-js/zip-obj.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@micro-js/zip-obj
npm package: @micro-nest/redis
Description: Smallest redis client to store key value pairs
Author: lovneet
Latest version: 1.0.3

# MICRO-NEST [Redis]

## Quick Start

- Install
  `npm i @micro-nest/redis`

- Imports

```
import { get, set, del, flushall, flushdb  } from "@micro-nest/redis"
import { publish, subscribe, psubscribe, psub, sub, } from "@micro-nest/redis"
import { random } from "@micro-nest/redis"
```

## Description

- Just install and start using
- Provides a set of helper functions to help you redis

## Code Less & Do More

- SSL mode auto configured
- Default is configured, just pass the options you want to override.
- Easy to use and configure.

## Todo:

- [ ] **@Ping** decorator

## Organization

<a href="https://radiansys.com" target="_blank"><img src="https://radiansys.com/_next/static/media/radiansys.6e55f863.svg"></a>

## Stay in touch

- Author - [Lovneet](https://github.com/Lovneet-s)

## License

@micro-nest is [MIT licensed](LICENSE).
npm package: @micro-nest/rest
Description: REST Api decorators & helpers
Author: lovneet
Latest version: 1.0.6

# MICRO-NEST [REST]

 <p align="center">
  <a href="https://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
</p>

[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest

  <p align="center">NestJs based decorators & helper functions for REST.</p>
    <p align="center">
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>

## Quick Start

- Install
  `npm i @micro-nest/rest`

- Imports

```
import { ApiController } from "@micro-nest/rest"
import { ApiGet, ApiPost, ApiPatch, ApiPut, ApiDelete } from "@micro-nest/rest"
```

## Description

- Provides a set of decorators to help you build REST apis with NestJs
- Provides a set of helper functions to help you REST apis with NestJs

## Code Less & Do More

- Naming conventions based decorators and function.
- Default is configured, just pass the options you want to override.
- Easy to use and configure.

## Todo:

- [ ] **@Ping** decorator
- [ ] Path params resolve in controller (currently by dto)

## Organization

<a href="https://radiansys.com" target="_blank"><img src="https://radiansys.com/_next/static/media/radiansys.6e55f863.svg"></a>

## Stay in touch

- Author - [Lovneet](https://github.com/Lovneet-s)

## License

@micro-nest is [MIT licensed](LICENSE).