https://github.com/janhancic/mirrorkey

Simple utility to create a object literal which has the same values as the key names.
https://github.com/janhancic/mirrorkey

Last synced: 2 months ago
JSON representation

Simple utility to create a object literal which has the same values as the key names.

• Host: GitHub
• URL: https://github.com/janhancic/mirrorkey
• Owner: janhancic
• License: mit
• Created: 2014-07-31T21:07:13.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-08-27T19:48:12.000Z (over 10 years ago)
• Last Synced: 2024-10-05T00:04:55.671Z (3 months ago)
• Language: JavaScript
• Size: 172 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# MirrorKey

A small utility that takes a object literal and returns a new object literal whose values are the same as keys.

The idea came from [react/utils/keyMirror](https://github.com/facebook/react/blob/master/src/utils/keyMirror.js) but I 

added transforms which allows you to transform the values. There are 5 available transforms: `none`, `camel-case`, 

`lower-case`, `dashed` & `lower-dashed`. You pass the transform in as the second argument (default is `none`),

This utility is useful for creating maps of constants, as it helps you to avoid having to type the same thing twice.

## Examples

```javascript

var myConstants = {

	MY_FOO: null,

	MY_BAR: null

};

mirrorKey(myConstants);

/*

{

	MY_FOO: 'MY_FOO',

	MY_BAR: 'MY_BAR'

}

*/

mirrorKey(myConstants, 'lower-dashed');

/*

{

	MY_FOO: 'my-foo',

	MY_BAR: 'my-bar'

}

*/

```

You can also pass in an array instead of an object:

```javascript

mirrorKey(['MY_FOO', 'MY_BAR']);

/*

{

	MY_FOO: 'MY_FOO',

	MY_BAR: 'MY_BAR'

}

*/

// you can also use transforms as above if you pass in an array

```

## Runtime support

Works in [node.js](http://nodejs.org/) and in the browser.

*I haven't yet tested this in every browser, but it should work as I haven't used any >ES5 functions.*

## Installation

Node, Browserify &  Webpack: `npm install mirrorkey`

Bower: `bower install mirrorkey`

Other: you can also just grap `mirrorkey_browser.js` or `mirrorkey_browser.min.js` and include them in your project 

manually. A global `mirrorkey` will be available on the `window` object.

## Developing

Clone this repository. Source code is in `mirrorkey.js` and the tests are in `spec/`. To run the tests you will need to 

install jasmine-node with `npm install jasmine-node -g`. After which you can run `npm test` to run the tests.

If you wish to build a browser version then run `npm install` and then `grunt` which will generate the browser versions 

for you.

## License

See LICENSE file.