@dungeonmaster/snaputils

🚀 Live Demo

See all utilities in action → snaputils-demo.netlify.app

📦 Demo Source

github.com/dungeonmaster/snaputils-demo

A lightweight, zero-dependency utility library for JavaScript & React apps.

Installation

npm install @dungeonmaster/snaputils

TypeScript Support

This package includes built-in TypeScript type definitions. No need to install any @types/ package separately!

```ts import { formatCurrency, isLeapYear, capitalize } from '@dungeonmaster/snaputils';

formatCurrency(1999.99, 'USD'); // ✅ autocomplete works isLeapYear(2024); // ✅ type checked capitalize('hello'); // ✅ type checked ```

Usage

import { capitalize, formatCurrency, timeAgo } from "@dungeonmaster/snaputils";

String Utilities

Function	Description	Example
capitalize(str)	Capitalize first letter	"hello" → "Hello"
truncate(str, max)	Truncate with ellipsis	"Hello World" → "Hello..."
toCamelCase(str)	Convert to camelCase	"hello world" → "helloWorld"
maskString(str, start, end)	Mask middle characters	"1234567890" → "12******90"
toTitleCase(str)	Title case a string	"hello world" → "Hello World"
isPalindrome(str)	Check if palindrome	"racecar" → true
countOccurrences(str, substr)	Count substring occurrences	2
reverseString(str)	Reverse a string	"hello" → "olleh"
toTitleCase(str)	Title case a string	"hello world" → "Hello World"
isPalindrome(str)	Check if palindrome	"racecar" → true
countOccurrences(str, substr)	Count substring occurrences	2
reverseString(str)	Reverse a string	"hello" → "olleh"
wordCount(str)	Count words	"hello world" → 2

Number & Currency Utilities

Function	Description	Example
formatCurrency(amount, currency, locale)	Format as currency	1999.99 → "$1,999.99"
formatNumber(num)	Add thousand separators	1000000 → "1,000,000"
formatPercent(value)	Format as percentage	0.75 → "75.0%"
abbreviateNumber(num)	Shorten large numbers	1500000 → "1.5M"
roundTo(num, decimals)	Round to decimal places	3.14159 → 3.14
isEven(num)	Check if even	4 → true
isOdd(num)	Check if odd	3 → true
randomBetween(min, max)	Random number in range	randomBetween(1, 10) → 7
formatFileSize(bytes)	Format bytes to readable size	1024 → "1.00 KB"
isEven(num)	Check if even	4 → true
isOdd(num)	Check if odd	3 → true
randomBetween(min, max)	Random number in range	7
formatFileSize(bytes)	Format bytes to readable	1024 → "1.00 KB"

Date & Time Utilities

Function	Description	Example
formatDate(date)	Full date string	"January 15, 2024"
formatShortDate(date)	MM/DD/YYYY format	"01/15/2024"
formatTime(date)	12-hour time	"02:30 PM"
timeAgo(date)	Relative time	"2 hours ago"
daysBetween(d1, d2)	Days between dates	10
addDays(date, days)	Add days to date	Returns new Date
isWeekend(date)	Check if date is weekend	true / false
isLeapYear(year)	Check if leap year	2024 → true
getDayName(date)	Get day name	"Monday"
getMonthName(date)	Get month name	"January"
isToday(date)	Check if date is today	true / false
isWeekend(date)	Check if date is weekend	true / false
isLeapYear(year)	Check if leap year	2024 → true
getDayName(date)	Get day name	"Monday"
getMonthName(date)	Get month name	"January"

✅ Validation Utilities

Function	Description	Example
isEmail(str)	Validate email format	"test@gmail.com" → true
isURL(str)	Validate URL format	"https://google.com" → true
isPhoneNumber(str)	Validate phone number	"+1234567890" → true

🔢 Array Utilities

Function	Description	Example
unique(arr)	Remove duplicates	[1,2,2,3] → [1,2,3]
groupBy(arr, key)	Group objects by key	{fruit: [...], veggie: [...]}
chunk(arr, size)	Split into chunks	[1,2,3,4,5] → [[1,2],[3,4],[5]]

🔧 Object Utilities

Function	Description	Example
omit(obj, keys)	Remove keys from object	{a:1, b:2} → {a:1}
pick(obj, keys)	Pick keys from object	{a:1, b:2} → {b:2}
deepClone(obj)	Deep clone an object	Returns new reference

🎨 Color Utilities

Function	Description	Example
hexToRgb(hex)	Hex to RGB object	"#ff5733" → {r:255, g:87, b:51}
rgbToHex(r,g,b)	RGB to hex string	255,87,51 → "#ff5733"
isValidHex(hex)	Validate hex color	"#ff5733" → true
lightenColor(hex, percent)	Lighten a color	"#ff5733", 20 → lighter hex
darkenColor(hex, percent)	Darken a color	"#ff5733", 20 → darker hex

🔐 Security Utilities

Function	Description	Example
generateUID(length?)	Generate unique ID	"x7f2k9q1m3"
hashString(str)	Hash a string	"99162322"
base64Encode(str)	Encode to Base64	"aGVsbG8="
base64Decode(str)	Decode from Base64	"hello"

📱 Device Utilities

Function	Description	Example
isMobile()	Detect mobile device	true / false
copyToClipboard(text)	Copy text to clipboard	true / false
getScrollPosition()	Get scroll position	{ x: 0, y: 200 }

🧮 Math Utilities

Function	Description	Example
sum(arr)	Sum of array	[1,2,3] → 6
average(arr)	Average of array	[1,2,3] → 2
median(arr)	Median of array	[1,2,3] → 2
factorial(n)	Factorial of n	5 → 120
min(arr)	Minimum value	[3,1,2] → 1
max(arr)	Maximum value	[3,1,2] → 3

🌍 URL Utilities

Function	Description	Example
parseURL(url)	Parse URL into parts	{ host, pathname, params }
buildQueryString(obj)	Object to query string	"name=harsh&age=25"
parseQueryString(str)	Query string to object	{ name: "harsh" }

⏱️ Performance Utilities

Function	Description	Example
debounce(fn, delay?)	Debounce a function	fires after delay
throttle(fn, limit?)	Throttle a function	fires once per limit
memoize(fn)	Cache function results	returns cached result

License

MIT