Utilities

These are a collection of the most commonly shared utility functions within our Javascript coded content. They help us retrieve data, interpret data, and sometimes manipulate data.

Installing

Using npm:

npm install @bizjournals/utilities

Configuring your environment:

You will need to configure an NPM_TOKEN within your project to include these private modules. The best idea is to use an existing project as an example.

For simple setups the .gitlab-ci.yml file within this project as a guide to accessing project variables via the .npmrc file

Example

import { isObject, empty } from "@bizjournals/js-utilities";

// Will report true
console.log(isObject({}));

// Will report false
console.log(isObject([]));

// Will report true
console.log(empty([])); 

API Reference

$ meta (key : String, fallback = null : Mixed) 

The meta helper retrieves the "content" from a meta html element. It queries based on the name or property attribute with the key provided in the arguments. The fallback is provided when either of the following conditions are met. The HTML meta element was not found, or the content attribute of that meta element was not set.

$ asset (path : String) 

The asset helper uses the CDN_URL constant from the @bizjournals/js-constants and the meta helper to look at the environment and return either a relative URI, when not in production, or a URI with the CDN_URL prepended. To use this helper you must have a meta element named "env" and that element must have content.

$ empty (value : Mixed) 

An empty check works very similar to an empty check in PHP. It takes any value and determines if that item contains a truthy result.

$ isObject (value : Mixed) 

The isObject helper will return true only when the object is of construction {...}.