Skip to content
Create a key<->value mirror. Useful for constants enumerations. Inspired by keymirror in Flux.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
src
test
.babelrc
.jshintrc
.npmignore
.tern-project
.travis.yml
CHANGELOG.md
README.md
index.js
package.json

README.md

KeyKey

Build Status via CodeShip Build Status bitHound Overalll Score bitHound Dependencies bitHound Dev Dependencies bitHound Code

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()
You can’t perform that action at this time.