instant-utils

Instant Utils

Lightweight utility library to assist other instant packages.

Table of Contents

• Installation
• Usage
• API
  • asyncForEach
  • asyncMap
  • pick
  • removeUndefineds
• Contributing
• License

Installation

You can install this package using npm:

$ npm install instant-utils

Usage

Here is a quick example to get you started:

ES Modules

import { pick } from 'instant-utils';

const country = { id: 1, name: 'Australia' };
const result = pick(country, ['name']);
console.log(result); // => { name: 'Australia' }

CommonJS Modules

var utils = require('instant-utils');

var country = { id: 1, name: 'Australia' };
var result = utils.pick(country, ['name']);
console.log(result); // => { name: 'Australia' }

API

asyncForEach

Asyncronous For Each function, enabling multiple loop iterations to be wrapped in one completion promise.

Arguments

arr (Array): The array to iterate over.
iteratee (Function): The function invoked per iteration.

Returns

Array

Example Usage

async function getCountries() {
  const countries = ['scotland', 'australia'],
  ];
  return await asyncForEach(countries, country => {
    const response = await fetch(`/api/countries/${country}`);
    return await response.json();
  });
}

asyncMap

Asyncronous Map function, enabling multiple map iterations to be wrapped in one completion promise.

Arguments

arr (Array): The array to iterate over.
iteratee (Function): The function invoked per iteration.

Returns

Array

Example Usage

async function mapCountries() {
  const countries = [
    { id: 'scotland', name: 'Scotland' },
    { id: 'australia', name: 'Australia' },
  ];
  return await asyncMap(countries, country => {
    return {
      ...country,
      visited: true,
    };
  });
}

pick

Creates an object composed of the picked object properties.

Arguments

obj (Object): The source object.
keys (Array): The property keys to pick.

Returns

Object

Example Usage

const country = { id: 1, name: 'Australia' };
const result = pick(country, ['name']);
console.log(result); // => { name: 'Australia' }

removeUndefineds

Creates an object composed of non-undefined-valued object properties.

Arguments

obj (Object): The source object.

Returns

Object

Example Usage

const country = { id: 1, name: 'Australia', unicorns: undefined };
const result = removeUndefineds(country);
console.log(result); // => { id: 1, name: 'Australia' }

Contributing

We'd greatly appreciate any contribution you make.

License

MIT