@bigbinary/neeto-cist

neeto-cist

A collection of common utility functions used across all our neeto products. Try out the utility functions live at neetoCommons REPL.

Contents

• Installation
• Usage
• Available functions
• Development

Installation

Install from npm:

yarn add @bigbinary/neeto-cist@latest

Install the peer dependencies:

yarn add ramda

Usage

You can import all functions from @bigbinary/neeto-cist.

import { slugify } from "@bigbinary/neeto-cist";

Exports several general utility functions that are used throughout neeto products. The functions are structured in a manner reminiscent of Ramda, enabling seamless interoperability among them.

Pure functions were designed to be fail fast. If you call findById(10, null), it will throw error saying that it can't iterate through null.

But for most such pure functions, there is a failsafe alternative available. The failsafe alternative function will be prefixed with _. Example: _findById(10, null) returns null, _findById(10, undefined) returns undefined and _findById(10, [{ id: 10 }]) returns { id: 10 }.

Available functions

Array operations	Object operations	String operations	General utility functions
findById findIndexById removeById replaceById modifyById existsById findBy findIndexBy removeBy replaceBy modifyBy existsBy findLastBy findLastIndexBy filterBy countBy renameKeys copyKeys copyKeysDeep	matchesImpl transformObjectDeep keysToCamelCase keysToSnakeCase serializeKeysToSnakeCase preprocessForSerialization deepFreezeObject matches filterNonNull	slugify humanize snakeToCamelCase camelToSnakeCase capitalize hyphenate truncate	nullSafe noop toLabelAndValue getRandomInt randomPick dynamicArray isNotEmpty isNot (notEquals) isNotPresent isPresent isNotEqualDeep (alias notEqualsDeep) modifyWithImmer

Development

• Development instructions
• API documentation logistics
• Building and releasing