Mirrarray

A very simple module for creating a keymirror object from an array of keys.

Installation

yarn add mirrarray

If you don't yet have Yarn installed, please see the documentation here: https://yarnpkg.com/lang/en/docs/install/

Usage

Import & pass mirrarray an array full of keys.

es6 module syntax:

import mirrarray from 'mirrarray';

const keymirror = mirrarray(['this', 'that', 'another']);

or commonjs:

var mirrarray = require("mirrarray");

var keymirror = mirrarray(['this', 'that', 'another']);

Please note that the commonjs example above is current to version 2.0.0. Earlier versions would have required you to enter require("mirrarray").default, but this was undocumented. Usage via es6 module syntax has not been changed.

Now keymirror is an object containing key/value pairs for each element in the input array.

{
  this: 'this',
  that: 'that',
  another: 'another'
}

Usable Key Types

• string
• number
• undefined
• null
• boolean

Non-strings will be coerced into a string for use as a key in the keymirror object in exactly the manner you'd expect. The corresponding value will still be of the original type.

So,

mirrarray([null]);

evaluates to

{
  'null': null
}

However, in order to avoid unexpected results, mirrarray will throw an error if the input array contains distinct elements that coerce into the same string, like 'true' and true.