Skip to content

README.md

Latest commit

 

History

History
121 lines (94 loc) · 3.27 KB

README.md

File metadata and controls

121 lines (94 loc) · 3.27 KB

Documentation

Comprehensive documentation for all utilities in the @setemiojo/utils library.

Available Utilities

Array

Utilities for working with arrays and array-like objects.

  • Array conversion (toArray, flattenArrayable, mergeArrayable)
  • Array manipulation (partition, uniq, uniqueBy, remove, move, shuffle)
  • Array access (at, last, sample)
  • Array generation (range)
  • Array utilities (clampArrayRange, filterInPlace)

Base

Core utility functions and helpers.

  • Assertions (assert)
  • Type utilities (toString, getTypeName)
  • Common helpers (noop)

Equal

Utilities for deep equality comparison.

  • Deep equality (isDeepEqual)

Function

Utilities for working with functions and function execution.

  • Function execution (batchInvoke, invoke, tap)

Guards

Type guards for filtering and type narrowing.

  • Null and undefined guards (notNullish, noNull, notUndefined)
  • Truthy guards (isTruthy)

Is

Type checking utilities for runtime type validation.

  • Basic type checks (isDef, isUndefined, isNull, isBoolean, isNumber, isString, isFunction, isObject)
  • Primitive checks (isPrimitive)
  • Specialized checks (isRegExp, isDate, isWindow, isBrowser)

Math

Utilities for mathematical operations and calculations.

  • Basic math (clamp, sum)
  • Interpolation (lerp, remap)

Object

Utilities for working with objects and object manipulation.

  • Object transformation (objectMap)
  • Object access (objectKeys, objectEntries, isKeyOf)
  • Object merging (deepMerge, deepMergeWithArray)
  • Object selection (objectPick)
  • Object utilities (clearUndefined, hasOwnProperty, objectId)

Promise

Utilities for working with promises and asynchronous operations.

  • Promise management (createSingletonPromise, sleep, createPromiseLock, createControlledPromise)

String

Utilities for working with strings and text manipulation.

  • String manipulation (slash, ensurePrefix, ensureSuffix, capitalize)
  • String templates (template)
  • String generation (randomStr)
  • String formatting (unindent)

Time

Utilities for working with time and timestamps.

  • Timestamp generation (timestamp)

p

Utility for managing multiple promises with a fluent API.

  • Promise collection and chaining
  • Concurrency control
  • Additional methods (forEach, reduce, clear)

Quick Start

import {
  // String utilities
  capitalize,
  createSingletonPromise,
  deepMerge,

  isObject,
  isString, // Type guards
  notNullish,

  // Object utilities
  objectMap,
  objectPick,
  partition,

  randomStr, // Promise utilities
  sleep,

  template, // Array utilities
  toArray,
  uniq,

  // And many more...
} from '@setemiojo/utils'

Installation

npm install @setemiojo/utils
# or
yarn add @setemiojo/utils
# or
pnpm add @setemiojo/utils
# or
bun add @setemiojo/utils

TypeScript Support

All utilities are fully typed and provide excellent TypeScript support with proper type inference and narrowing.

Contributing

See CONTRIBUTING.md for guidelines on contributing to this project.