# @source4society/scepter-utility-lib

> Useful functions commonly used within application development

Latest version **5.0.0** (published 2019-09-29) · AGPL-3.0 license · 0 weekly downloads

## Install

```sh
npm install @source4society/scepter-utility-lib
pnpm add @source4society/scepter-utility-lib
yarn add @source4society/scepter-utility-lib
bun add @source4society/scepter-utility-lib
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.0.0 |
| Published | 2019-09-29 |
| First published | 2018-01-09 |
| Weekly downloads | 0 |
| License | AGPL-3.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 307.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Source 4 Society |
| Maintainers | danfredriksen |

## Links

- npm: https://www.npmjs.com/package/@source4society/scepter-utility-lib
- Repository: https://github.com/source4societyorg/SCEPTER-utility-lib
- npm.io page: https://npm.io/package/@source4society/scepter-utility-lib

## Recent versions

- 5.0.0 (latest) — 2019-09-29
- 4.1.0 — 2018-05-25
- 4.0.1 — 2018-05-16
- 4.0.0 — 2018-05-16
- 3.0.0 — 2018-05-03
- 2.3.0 — 2018-04-29
- 2.2.0 — 2018-04-27
- 2.1.0 — 2018-03-26
- 2.0.0 — 2018-03-26
- 1.2.0 — 2018-03-14
- 1.1.0 — 2018-02-22
- 1.0.0 — 2018-02-19
- 0.0.26 — 2018-02-18
- 0.0.25 — 2018-02-13
- 0.0.24 — 2018-02-08
- … 21 more at https://npm.io/package/@source4society/scepter-utility-lib/versions

## README

# SCEPTER-utility-lib
[![scepter-logo](http://res.cloudinary.com/source-4-society/image/upload/v1514622047/scepter_hzpcqt.png)](https://github.com/source4societyorg/SCEPTER-core)

[![js-standard-style](https://cdn.rawgit.com/standard/standard/master/badge.svg)](http://standardjs.com)

[![Build Status](https://travis-ci.org/source4societyorg/SCEPTER-utility-lib.svg?branch=master)](https://travis-ci.org/source4societyorg/SCEPTER-utility-lib.svg?branch=master)

[![codecov](https://codecov.io/gh/source4societyorg/SCEPTER-utility-lib/branch/master/graph/badge.svg)](https://codecov.io/gh/source4societyorg/SCEPTER-utility-lib)

A library of useful javascript utility functions

## Usage

Add this library to your project via `npm` or `yarn` with the command:

    npm install -S @source4society/scepter-utility-lib
or
    yarn add @source4society/scepter-utility-lib

Then in your code, you can import the utility class:

    import SCEPTERUtils from '@source4society/scepter-utility-lib';

or for commonJS

    const SCEPTERUtils = require('@source4society/scepter-utility-lib')

## Functions

### isEmpty / isNotEmpty

use this to determine if a given variable is "empty". "Emptiness" is defined as an undefined value, null, NaN, {}, [], or ''. A value such as boolean `false` is not counted as empty, nor is a `function` or a `class` (instantiated or definition). `isNotEmpty` is simply the `not` of `isEmpty`

### getRandomInt

Specify a `min` (inclusive) and `max` (exclusive) to get back a random number based on the platform (or injected) `Math.random()` function between min/max

### valueOrDefault

If the value is empty, return default, otherwise return the value. Very useful for avoiding ternary's for better line coverage when setting default values

### ssValueOrDefault

Same as above, but the second argument is a function or lambda to be executed if the first argument is empty. SS stands for "short-circuit".

### ifTrueElseDefault

If the first argument evaluates to true, return the second argument, otherwise return the third. Very useful for avoiding branching logic but beware - you cannot short circuit the arguments like you can with a normal ternary

### ssIfTrueElseDefault

Like above but value1 and value2 should be defined as functions or lambdas to provide short circuiting.

### emptyAt / notEmptyAt

Like `isEmpty` and `isNotEmpty` but will traverse an objects properties to see if the property chain exists/has an empty value. The first argument is the object, the second argument is an array of subproperties to search in the order of nesting.

### ucFirst

Useful utility to transform a word to title case (first letter becomes uppercase). Pass in a string and get back a string

### validateApiResult

SCEPTER API results always return with a `status: true` property when successful, and `status: false` when something goes wrong. This will attempt to throw the error in the response if status is anything other than true. It will also parse from a string if the given result is in string form.

### keyGenerator

Generates a random character string of `length` length, useful for creating API keys or jwt encoding keys.

### getInOrDefault

This is useful for getting values from nester properties within objects, and returning a default value if the property does not exist or is empty. The first argument is the object to search, the second is an array of properties in nesting order, the third is the default value to return if the property does not exist or is empty

### immutableToJS

Convert an immutable object to its JS form if the object is not empty, otherwise return undefined. Simply takes the immutableJS object as an argument

### standardCallback

Use this to split the results of a standard callback into two separate function calls. The first argument is the error object, the second is the success (data) object. If the error object is not empty, then the error callback is called with the error data, otherwise the success callback is called with the success data

## eitherOf

Use this function to disjoin (||) two values

## conjunctionOf

Use this function to conjoin (&&) two values

## ssEitherOf

Use this function to disjoin (||) two values, but the second argument should be a function that will be executed if the first is not true or undefined

## ssConjunctionOf

Use this function to conjoin (&&) two values, but the second argument should be a function that will be executed if the first is not true or undefined

## trueIfEqual

Function will return the result of value1 === value2

## nullOp

Returns null value, useful if you want to return null in a short circuited function or if you want to render a null React component

---
_Source: https://npm.io/package/@source4society/scepter-utility-lib · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._