JSPM

  • Created
  • Published
  • Downloads 492
  • Score
    100M100P100Q83387F
  • License MIT

JS utility methods for NODE and Browser.

Package Exports

  • js-flock

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (js-flock) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

js-flock

Build Status Code quality Open Source Love MIT Licence

npm install js-flock --save

JS utility methods for NODE and Browser. Requires ES6 environment as minimum to run the code.

Methods:

promisify

Promisify error first callback function

  const promisify = require('js-flock').promisify;
  const readFile = require("fs").readFile;

  const readFileAsync = promisify(readFile); // Promise version of read file

  // Native version of read file
  readFile('test.txt', 'utf8', (err, data) => {
    if (err) {
      return console.log(err);
    }
    console.log(data);
  });

  // Promisify version
  readFileAsync('test.txt', 'utf8')
    .then((data) => console.log(data))
    .catch((err) => console.log(err));

collar

Set maximum waiting time for promise to resolve. Reject promise if it's not resolved in that time

  const collar = require('js-flock').collar;

  const MAX_WAIT_TIME = 500;

  collar(Promise.all([
    new Promise((resolve) => setTimeout(resolve, 50, '1')),
    new Promise((resolve) => setTimeout(resolve, 100, '2'))
  ]), MAX_WAIT_TIME)
  .then(([first, second]) => {
    console.log('this is called as promises are resolved before timeout')
  }).catch((err) => console.log('this is not called'));

  collar(
    new Promise((resolve) => setTimeout(resolve, 1000, '1')),
    MAX_WAIT_TIME
  ).then((data) => {
    // This is not called
  }).catch((err) => {
    if(typeof err = 'object' && err.isStrangled) {
      // collar have rejected promise because it have timed out
      console.log(err); // err = { isStrangled: true, message: 'Promises have timed out' }
    }
  });

  collar(Http.get('test-url'), MAX_WAIT_TIME)
    .then((response) => console.log(response))
    .catch((err) => console.log('promise have timed out'));

toEnum

Convert object or list of strings to enum representation. Enum representation is immutable (frozen)

  const toEnum = require('js-flock').toEnum;

  const vehicleType = toEnum({
    TRUCK: 'TRUCK',
    CAR: 'CAR',
    MOTORBIKE: 'MOTORBIKE',
    CAMPER: 'CAMPER'
  });

  // We can also use short notation to define above enum when keys are equal to values.
  // Both enum representations are equal

  const vehicleType = toEnum(['TRUCK', 'CAR', 'MOTORBIKE', 'CAMPER']);

  if(vehicle.type === vehicleType.TRUCK) {
    // Special behaviour only for truck vehicles
  }

  vehicleType.TRUCK = 'boat';
  vehicleType.BOAT = 'BOAT';

  console.log(vehicleType.TRUCK); // TRUCK - enum is immutable
  console.log(vehicleType.BOAT); // undefined - enum is immutable

  // Following enum can't be written in short notation as keys are different then values

  const gender = toEnum({
    MAN: 'M',
    WOMEN: 'W',
    OTHER: 'O'
  });

  // Enum helpers

  gender.keys(); // return array of keys ['MAN', 'WOMEN', 'OTHER']
  gender.values(); // return array of values ['M', 'W', 'O']

  gender.exists('W'); // true
  gender.exists('T'); // false

  gender.haveKey('MAN'); // true
  gender.haveKey('CAR'); // false

sort

Small wrapper around sort to make sorting more readable and easier to write. Undefined and null values are always sorted to bottom of list no matter if ordering is ascending or descending.

  const sort = require('js-flock').sort;

  sort([1,2,4]).asc(); // sort array in ascending order
  sort([1,2,4]).desc(); // sort array in descending order

  // Sort persons (array of objects) ascending by lowercase names
  sort(persons).asc((p) => p.name.toLowerCase());

  // Above statement is equivalent to
  persons.sort((a, b) => {
    // == null are true for undefined and null.
    // We need to check that first in order to move undefined/null values to bottom of list
    if (a.name == null) return 1;
    if (b.name == null) return -1;

    // Cast to lowercase if there is value
    const aName = aName.toLowerCase();
    const bName = bName.toLowercase();

    if (aName === bName) return 0;
    if (aName < bName) return -1; // Is this asc or desc sorting?? let's check documentation
    return 1;
  });

  // There is no exception if we try to sort values that are not sortable
  // In that case sort just return input value
  sort(null).asc(); // return null
  sort(33).desc(); // return 33

deepFreeze

Recursively apply Object.freez

  const deepFreeze = require('js-flock').deepFreeze;

  const person = {
    fullName: 'test person',
    dob: new Date(),
    address: {
      country: 'testiland',
      city: 'this one'
    }
  }

  Object.freeze(person);

  Object.isFrozen(person); // true
  Object.isFrozen(person.address); // false UH OH

  deepFreeze(person);

  Object.isFrozen(person); // true
  Object.isFrozen(person.address); // true WE HE

deepSeal

Recursively apply Object.seal. For example check deepFreeze