@kuoki/anymap

Anymap

A helper class for testing use cases where the value is of type any

Table of Contents

1. About The Project
2. Getting Started
3. Usage

About The Project

The Anymap object is useful to test functions or methods that uses arguments with the types any or undefined because contains all the standard JavaScript data types in a dictionary, allowing filtering them using the data type keys or using a filter function. In this way, the code can be strengthened by testing all existing types and their behavior.

Getting Started

Installation

Using NPM

npm install --save-dev @kuoki/anymap

Using Yarn

yarn add --dev @kuoki/anymap

Usage

Create an instace of Anymap and use the methods to chain operations to get the desired result.

const objectValues = new Anymap().exclude('null').filter((value) => typeof value === 'object').values;

The class exposes four types of ways to get the final desired data. The dictionary is a plain object with the key and the list of values that represents.

type dictionary = Record<string, any[]>;

const anymap = new Anymap().include('boolean', 'null');
anymap.dict; // {boolean:[true,false],null:[null]}
anymap.keys; // ['boolean','null']
anymap.values; // [true,false,null]
anymap.entries; // [['boolean':true],['boolean':false],['null',null]]

Available keys

anonymousFunction, Array, ArrayBuffer, Atomics, BigInt64Array, bigint, BigUint64Array, binary, Boolean, DataView, Date, decimal, Document, DocumentFragment, Element, Error, EvalError, Event, exponent, Float32Array, Float64Array, hexadecimal, Infinity, Int16Array, Int32Array, Int8Array, integer, JSON, Map, Math, namedFunction, namedObject, NaN, null, Number, octal, plainObject, RangeError, ReferenceError, RegExp, Set, SharedArrayBuffer, string, String, Symbol, SyntaxError, TypeError, Uint16Array, Uint32Array, Uint8Array, Uint8ClampedArray, undefined, URIError, WeakMap, WeakSet, Window,boolean

Use cases

Table of Contents

1. Add
2. Clear
3. Include
4. Exclude
5. Union
6. Except
7. Filter
8. Intersect
9. Use in a test
10. Common filters

Add

new Anymap().include('string').add({ string: [' '] }).dict;
// {string:['',' ']}
new Anymap().include('null').add({ myObject: [{ a: 'a' }] }).dict;
// {null:[null],myObject:[{a:'a'}]}

Clear

new Anymap().include('null').dict;
// {null:[null]}
new Anymap().include('null').clear().dict;
// {}

Include

new Anymap().include('null').dict;
// {null:[null]}
new Anymap().include('null', 'boolean').dict;
// {null:[null],boolean:[true,false]}

Exclude

const test = new Anymap().include('null', 'boolean');

test.dict;
// {null:[null],boolean:[true,false]}
test.exclude('null').dict;
// {boolean:[true,false]}

Union

const a = new Anymap().include('null');
const b = new Anymap().include('boolean');

a.union(b).dict;
// {null:[null],boolean:[true,false]}

Except

const a = new Anymap().include('null', 'boolean');
const b = new Anymap().include('boolean');

a.except(b).dict;
// {null:[null]}

Intersect

const a = new Anymap().include('null', 'boolean');
const b = new Anymap().include('boolean');

a.intersect(b).dict;
// {boolean:[true,false]}

Filter

new Anymap().include('null', 'boolean').filter((value) => Boolean(value)).dict;
// {boolean:[true]}

Use in a test

import { Anymap } from '@kuoki/anymap';

function isFalsy(arg: any): boolean {
  return Boolean(arg) === false;
}

describe('isFalsy', () => {
  const falsy = new Anymap().filter((v) => Boolean(v) === false);
  const truthy = new Anymap().except(falsy);

  falsy.entries.forEach(([key, value]) => {
    it(`isFalsy(${key} ${String(value)}) returns true`, () => {
      expect(isFalsy(value)).toEqual(true);
    });
  });

  truthy.entries.forEach(([key, value]) => {
    it(`isFalsy(${key} ${String(value)}) returns false`, () => {
      expect(isFalsy(value)).toEqual(false);
    });
  });
});

Common filters

import { Anymap } from '@kuoki/anymap';

const numbers = new Anymap().filter((value) => typeof value === 'number');
const falsies = new Anymap().filter((value) => Boolean(value) === false);
const iterables = new Anymap().filter((value) => typeof value[Symbol.iterator] === 'function');