dbl-utils

dbl-utils is a JavaScript/TypeScript utility library designed to simplify common application development tasks. This collection includes functions for event handling, queue processing, text manipulation, and date and currency formatting, among others.

Table of Contents

• Installation
• Usage
• Main Modules
• Utilities
• Documentation
• License

Installation

You can install dbl-utils via npm:

npm install dbl-utils

Or using yarn:

yarn add dbl-utils

Usage

Import the modules and functions in your project as needed. Below is a basic example of how to use dbl-utils:

// Import individual functions
import { formatCurrency, flatten, t } from 'dbl-utils';
// Use functions
console.log(formatCurrency(1234.56)); // Example of currency formatting
console.log(flatten({ a: { b: { c: 1 } } })); // Converts a nested object into a flat object

Imports directly from any file to don't include all:

CommonJS use /dist/cjs/*

// Import individual functions
const i18n = require('dbl-utils/dist/cjs/i18n');
// Use functions
console.log(i18n.formatCurrency(1234.56));

ESM use /dist/esm/*

// Import individual functions
import t, { formatCurrency } from 'dbl-utils/dist/esm/i18n';
// Use functions
console.log(i18n.formatCurrency(1234.56));

TypeScript use /src/*

// Import individual functions
import t, { formatCurrency } from 'dbl-utils/src/i18n';
// Use functions
console.log(i18n.formatCurrency(1234.56));

For a complete reference of all available functions, visit the full documentation here.

Main Modules

Below are the main modules available in dbl-utils:

• event-handler
• fetch-queue
• flat
• format-value
• i18n
• object-mutation
• resolve-refs
• utils

Utilities

• event-handler
  • eventHandler
  • EventHandler
• fetch-queue
  • FetchQueue
• flat
  • flatten
  • unflatten
• format-value
  • formatValue
• i18n
  • trackingTexts
  • getTexts
  • addDictionary
  • addFormatDate
  • addFormatTime
  • addFormatDateTime
  • addFormatNumber
  • addFormatNumberCompact
  • addFormatCurrency
  • addTasks
  • removeTask
  • setLang
  • getLang
  • formatDate
  • formatTime
  • formatDateTime
  • formatNumber
  • formatNumberCompact
  • formatCurrency
  • t
• object-mutation
  • mergeWithMutation
  • deepMerge
  • transformJson
• resolve-refs
  • resolveRefs
• utils
  • sliceIntoChunks
  • splitAndFlat
  • generateRandomColors
  • evaluateColorSimilarity
  • normalize
  • slugify
  • randomS4
  • randomString
  • timeChunks
  • delay
  • hash
  • LCG

Documentation

For a detailed description of each module and function, visit the full documentation automatically generated with Typedoc. The documentation includes usage examples and in-depth explanations of each function.

License

This project is under the ISC license. See the LICENSE file for more details.