Sweet JS Tools

A library of practical & reusable utilities designed to streamline everyday development, making JavaScript/TypeScript code cleaner, safer, and more consistent.

• Overview
• Installation
• Contents
  • String tools
  • Array tools
  • Number tools
  • Object tools
  • Data tools
  • TypeTools (basic)

Overview ✨

As a tool set, Sweet JS Tools focuses on:

• ease of use
• reducing repetitive logic
• safe defaults (no unexpected crashes)
• improving code clarity without adding complexity

The library provides a set of tools and common operations for arrays, numbers, objects, strings, and structured data.

tl;dr: Streamline JS/TS development. Practical, simple, easy. ✨

Installation

npm install sweet-js-tools

Sweet JS Tools is built on top of Sweet TypeTools, which is installed automatically as a dependency.

Contents

🔤 String Tools

Helpers for cleaning, formatting, and transforming text.

• capitalization and sentence formatting: capitalize, capitalizeText
• pattern matching and counting: matchCount, wordCount
• spacing and normalization: trimExtra, normalizeString, normalizeText
• slug and case conversion: slugMaker, toSnakeCase, toKebabCase
• symbol handling: removeSymbols, replaceSymbols
• regex helpers: escapeRegex

Example usage:

capitalizeText("hello. how are you?")
// "Hello. How are you?"

slugMaker("Münchener Straße")
// "munchener-strasse"

wordCount("hello @you 123")
// 3

🏹 Array Tools

Utilities for creating, filtering, sorting & working with arrays.

• generate sequences from numbers: arrayFromNr, zeroToNumber
• map and extract object properties: propMap, propMapCull
• sorting and transformation: sortNumbers, toArray
• access and selection: arrayLast, randomArrayItem
• cleanup and structure: removeDuplicates, arrayParts, paginationSlices
• type-based filtering (Sweet Types): includeType, excludeType, typeOrDefault, typeMatchMap

Example usage:

arrayFromNr(-5, 0)
// [-4, -3, -2, -1, 0]

removeDuplicates([1, 2, 2, 3])
// [1, 2, 3]

🔢 Number Tools

Consistent and predictable number behavior.

• rounding that works the same for positive and negative values: absValueFloor, absValueCeil
• safe random number generation: randomNr, randomNr0, randomInRange, randomUpTo, randomBetween
• decimal precision helpers: floorDecimal, ceilDecimal, roundDecimal
• number checks and helpers: isOdd, isEven, evenOdd
• range control: clamp
• factor utilities: findFactors, findLowestCommonFactor

Example usage:

absValueFloor(-2.1)
// -2 (instead of -3 with Math.floor)

randomInRange(2, 5)
// 2, 3, 4, or 5

📦 Object Tools

Utilities for cleaning, filtering, modifying, and reshaping objects.

• inspect object entry types: objEntryTypes
• clean empty or unclear values: fixEmptyVals, fixEmptyX
• extract cleaned object data: cleanEntries, cleanKeys, cleanValues
• extract clear object data: clearObjEntries, clearObjKeys, clearObjValues
• filter object entries: objFilter
• modify object keys or values: objModKeys, objModVals
• safely select or exclude keys: objPick, objOmit

Example usage:

fixEmptyVals({
  name: "",
  age: 32,
  city: "Munich"
})
// { age: 32, city: "Munich" }

objModKeys(
  { firstName: "Lina" },
  key => key.toUpperCase()
)
// { FIRSTNAME: "Lina" }

objPick(
  { name: "La", surname: "Gos" },
  ["name", "surname", "age"],
  "unknown"
)
// {
//   name: "La",
//   surname: "Gos",
//   age: "unknown"
// }

🗂️ Data Tools

Detect and parse structured data easily & automatically.

• detect data formats: stringDataCheck, findDataType
• JSON detection: isStructuredJSON
• CSV parsing: splitCSVRow, isCSVString, csvObjectify
• conversion helpers: csvToJSON, parseData

Example usage:

findDataType('{"name":"Lina"}')
// "json"

parseData("name,age\nLina,32")
// [{ name: "Lina", age: "32" }]

csvObjectify(
  'name,notes\nLina,"likes cats, coffee"'
)
// [
//   {
//     name: "Lina",
//     notes: "likes cats, coffee"
//   }
// ]

csvToJSON("name,age\nLina,32")
// '[{"name":"Lina","age":"32"}]'

🍬 TypeTools

Sweet JS Tools re-exports the most commonly used runtime utilities from Sweet TypeTools, allowing them to be used directly alongside the other Sweet JS helpers.

TypeTools extends JavaScript's native runtime typing with:

• Base type detection
• X value refinement
• Adapt helpers for interpretation and conversion

Additional Sweet JS Tools helpers:

• isTrue
• isFalse
• isClearValue

Includes:

• Base type checks: isString, isNumber, isBoolean, isObject, isArray, isNull, isUndefined, isBigint, isFunction, isSymbol
• Base type resolution: sweetType
• X value refinement: stringX, objectX, arrayX, numberX, symbolX
• X type resolution: sweetX, sweetXCheck
• Adapt helpers: isNumeric, isNullish, isEmptyVal
• Sweet JS additions: isTrue, isFalse, isClearValue

For the complete runtime type system and documentation, see the standalone Sweet TypeTools package.

Example usage:

isNumeric(" 12 ")
// true

isNumeric(12)
// false

isObject([1, 2])
// false

isArray([1, 2])
// true

sweetType([1, 2])
// "array"

sweetType([])
// "array"

sweetX([])
// "arrayX"

isClearValue(false)
// false