key

keykey

Create a key<->value mirror. Useful for constants enumerations. Inspired by keymirror in Flux.

Showing:

Popularity

Downloads/wk

3.2K

GitHub Stars

6

Maintenance

Last Commit

7mos ago

Contributors

4

Package

Dependencies

2

Size (min+gzip)

3.0KB

License

MIT

Type Definitions

Tree-Shakeable

No?

Categories

Readme

KeyKey

Build Status via CodeShip Build Status

The shaman's KeyMirror-alternative.

  • Create enumerations
  • Functional-programming friendly (pass keys individually or as an array)
  • Performs well in hot code paths
  • Works in Node and browsers via Browerify
> require('keykey')( 'FOO', 'BAR', 'BAZ' )

{
    FOO: 'FOO',
    BAR: 'BAR',
    BAZ: 'BAZ'
}

KeyKey is a micro utility module which provides a consistent way to declare constants. KeyKey achieves a very simple task, but it tries to do so in a way that will encourage innovative use. KeyKey offers functional programming capabilities by allowing keys to be passed individually or via an array. KeyKey makes constants not just from strings, but also from any JavaScript object. It caches the resulting key mirrors, making subsequent calls faster. And this cache is accessible if needed, which could provide an interesting look into constants across your application. Check out the performance test in /test.

Plus, hey—no unnecessary nulls.

Install

npm install keykey

Quick Start

Create constants with caching

const keykey = require('keykey')

// Arrays of keys
keykey(['foo','bar','baz']) // result -> {foo:'foo',bar:'bar',baz:'baz'}

// Individual keys
keykey('foo',true,'baz') // bools, if not in the final position, are treated as keys

Bypass the cache

keykey(['foo','bar','baz'], false) // no get/set
keykey('foo','bar','baz', false) // bools in the final position are treated as a cache switch

Clear the entire cache

keykey.reset() // or 
keykey.resetCache()

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial