@jsepia/utils

Util

My utility library. Because some wheels still need to be reinvented.

Utilities

Feature detection

isBrowser

import {isBrowser} from '@jsepia/utils'

if (isBrowser()) {
  document.createElement('canvas')
}

ID

IDGenerator

import {IDGenerator} from '@jsepia/utils'

const catIDGenerator = new IDGenerator()
const dogIDGenerator = new IDGenerator()

function createCat(name) {
  return {
    id: catIDGenerator.generateID()
    name: name,
    toy: 'scratcher'
  }
}

function createDog(name) {
  return {
    id: dogIDGenerator.generateID()
    name: name,
    toy: 'ball'
  }
}

generate-id

import {generateID} from '@jsepia/utils'

const entities = []

function spawnMonster() {
  entities[generateID()] = new Monster()
}

function spawnNPC() {
  entities[generateID()] = new NPC()
}

function getEntityType(id) {
  if (entities[id] instanceof Monster) {
    return 'monster'
  }
  else if (entities[id] instanceof NPC) {
    return 'npc'
  }
  return 'unknown'
}

Object

deepMerge

import {deepMerge} from '@jsepia/utils'

const defaults = {
  targets: {
    'app.js': 'src/**/*.js',
    'tests.js': 'test/**/*.js'
  },
  verbose: false
}

const userPreferences = {
  targets: {
    'libs.js': 'lib/**/*.js'
  }
}

const commandLineParams = {
  verbose: true
}

const options = deepMerge(defaults, userPreferences, commandLineParams)

Output:

{
  "targets": {
    "app.js": "src/**/*.js",
    "tests.js": "test/**/*.js",
    "libs.js": "lib/**/*.js",
  },
  "verbose": true
}

URL/URI manipulation

buildUri

import {buildUri} from '@jsepia/utils'

buildUri({
  // it supports the basic options you would expect
  protocol: 'http',
  host: 'juliosepia.com',
  port: '8080',
  path: '/posts/util.html',
  anchor: 'introduction', // hash

  // you can pass credentials separately
  user: 'jsepia',
  password: 'hunter2',

  // or as a single string
  userInfo: 'jsepia:hunter2',

  // you can pass query params separately
  queryKey: {
    version: '1.0',
    format: 'html'
  },

  // or as a single string
  query: 'version=1.0&format=html',
})

Output:

http://jsepia:[e-mail]:8080/posts/util.html?version=1.0&format=html#introduction

parseUri

Original by Steven Levithan

parseUri('http://jsepia:[e-mail]/posts/util.html?version=1.0&format=html#introduction')

Output:

{
  "anchor": "introduction",
  "authority": "jsepia:[e-mail]",
  "directory": "/posts/",
  "file": "util.html",
  "host": "juliosepia.com",
  "password": "hunter2",
  "path": "/posts/util.html",
  "port": "",
  "protocol": "http",
  "query": "version=1.0&format=html",
  "queryKey": {
    "format": "html",
    "version": "1.0",
  },
  "relative": "/posts/util.html?version=1.0&format=html#introduction",
  "source": "http://jsepia:[e-mail]/posts/util.html?version=1.0&format=html#introduction",
  "user": "jsepia",
  "userInfo": "jsepia:hunter2"
}

Validation

isValidUrl

import {isValidUrl} from '@jsepia/utils'

const url = prompt('enter URL here')
if (isValidUrl(url)) {
  request(url).then(
    (response) => handleResponse,
    (err) => handleError
  )
}
else {
  handleError(new Error(`Invalid URL: ${url}`))
}

XHR

Functions that make AJAX requests and return promises.

get

import {get} from '@jsepia/utils'

get(
  '/api/posts',
  {limit: 10, offset: 50},
  'json'
  )
  .then(
    (successfulResponse) => {
      const posts = response.posts
      posts.forEach((post) => {
        renderPost(post)
      })
    },
    (errorResponse) => {
      if (errorResponse && errorResponse.errorMessage) {
        throw new Error(errorResponse.errorMessage)
      }
      else {
        throw new Error('Request failed')
      }
    }
  )

TODO

• Test the exported library
• Customize neutrino-preset-web to not output any HTML.