DXKit JS Kit

Modern TypeScript utility library with tree-shaking support - Comprehensive collection of array, string, number, sleep, and time utilities for JavaScript and TypeScript projects.

A collection of JavaScript/TypeScript utility functions for modern development.

🌐 Environment Compatibility

This library is designed to work across multiple JavaScript environments:

• ✅ @dxkit-org/js-kit - Universal utilities that work in Node.js, Browser, and Web Workers
• ** Individual imports** - @dxkit-org/js-kit/module/function for maximum tree-shaking

Features

• 🚀 TypeScript Support - Full TypeScript support with type definitions
• 📦 Tree Shakable - Import only what you need
• 🧪 Well Tested - Comprehensive test coverage
• 📖 Well Documented - JSDoc comments for all functions
• 🔧 Modern Build - Built with tsup for optimal bundling
• 💡 Excellent IDE Support - Full auto-completion and IntelliSense support
• 🌐 Cross-Platform - Works in Node.js, browsers, and web workers

Installation

npm install @dxkit-org/js-kit

Alternative package managers:

# Yarn
yarn add @dxkit-org/js-kit

# pnpm
pnpm add @dxkit-org/js-kit

# Bun
bun add @dxkit-org/js-kit

Usage

Universal Modules

Import universal modules that work in Node.js, Browser, and Web Workers:

import {
  chunk,
  capitalize,
  clamp,
  sleep,
  convertToSeconds,
  randomStringWithFixedLength,
  truncateText,
  convertToInt,
  getUnixTimestamp,
  isNodeEnvironment,
} from "@dxkit-org/js-kit"

// Array utilities
const chunkedArray = chunk([1, 2, 3, 4, 5], 2)
// Result: [[1, 2], [3, 4], [5]]

// String utilities
const capitalizedString = capitalize("hello world")
// Result: "Hello world"

const randomId = randomStringWithFixedLength(8)
// Result: "a7b9c2d1" (example)

const truncated = truncateText({ text: "This is a long text", maxLength: 10 })
// Result: "This is a..."

// Number utilities
const clampedNumber = clamp(15, 0, 10)
// Result: 10

const safeInt = convertToInt("123.45")
// Result: 123

// Sleep utilities
await sleep({ seconds: 2, milliseconds: 500 }) // Sleep for 2.5 seconds

// Time utilities
const seconds = convertToSeconds({ minutes: 5, seconds: 30 })
// Result: 330 (seconds)

const timestamp = getUnixTimestamp()
// Result: current timestamp in seconds

// Environment utilities
const isNode = isNodeEnvironment()
// Result: true if running in Node.js

Tree-shaking Support

You can also import individual functions for optimal tree-shaking:

// Universal utilities - individual imports
import { chunk } from "@dxkit-org/js-kit/array"
import { capitalize, truncateText } from "@dxkit-org/js-kit/string"
import { clamp, convertToInt } from "@dxkit-org/js-kit/number"
import { sleep, sleepMs } from "@dxkit-org/js-kit/sleep"
import { convertToSeconds, getUnixTimestamp } from "@dxkit-org/js-kit/time"
import { isNodeEnvironment, getEnvironment } from "@dxkit-org/js-kit/utils"

// Universal bundle (recommended)
import {
  chunk,
  capitalize,
  clamp,
  sleep,
  convertToSeconds,
} from "@dxkit-org/js-kit"

📋 Available Modules

✅ Universal Modules (Node.js + Browser + Web Workers)

TypeScript Configuration

For optimal compatibility with this package, ensure your tsconfig.json uses modern module resolution:

{
  "compilerOptions": {
    "moduleResolution": "bundler", // or "node16"/"nodenext"
    "module": "ESNext", // or "Node16"
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true,
    "skipLibCheck": true
  }
}

Troubleshooting Import Issues

If you encounter module resolution errors like:

Cannot find module '@dxkit-org/js-kit/string/capitalize' or its corresponding type declarations

Try these solutions:

1. Update your TypeScript configuration to use modern module resolution (see above)
2. Ensure you're using a recent Node.js version (16+ recommended)
3. Copy the example configuration from example-tsconfig-for-consumers.json in this package
4. As a workaround, you can import directly from the dist folder:

   import { capitalize } from "@dxkit-org/js-kit/dist/string/capitalize.js"

IDE Support

This package provides excellent IDE support with:

• Auto-completion for all functions and their parameters
• Type checking with full TypeScript support
• JSDoc documentation shown in hover tooltips
• Auto-import suggestions when typing function names

API Reference

📚 Package Documentation

For comprehensive documentation with examples, advanced usage patterns, and best practices, see the individual package documentation:

• 🔢 Array Utilities - Array manipulation and chunking utilities
• 🔢 Number Utilities - Number clamping, conversion, and range validation
• ⏰ Sleep Utilities - Advanced sleep and timing functions
• 📝 String Utilities - String manipulation and formatting
• ⏰ Time Utilities - Time conversion and duration utilities
• 🌐 Environment Utilities - Environment detection and cross-platform utilities

Quick Reference

Array Utilities

• chunk<T>(array: T[], size: number): T[][] - Splits an array into chunks of a specified size

String Utilities

• capitalize(str: string): string - Capitalizes the first letter of a string
• capitalizeWords(str: string): string - Capitalizes the first letter of each word
• convertCamelToNormalCapitalized(str: string): string - Converts camelCase to Normal Capitalized format
• randomStringWithFixedLength(length: number): string - Generates a random string with fixed length
• truncateText(options: TruncateTextOptions): string - Truncates text with customizable options

Number Utilities

• clamp(number: number, lower: number, upper: number): number - Clamps a number within bounds
• inRange(number: number, lower: number, upper: number): boolean - Checks if number is in range
• convertToInt(data: any): number - Safely converts any value to integer
• convertToTwoDecimalInt(data: any): number - Converts to number with 2 decimal places
• randomNumberWithFixedLength(length: number): number - Generates random number with fixed length

Sleep Utilities

• sleep(params: TSleepParams): Promise<void> - Advanced sleep with flexible options
• sleepMs(ms: number): Promise<void> - Sleep for milliseconds
• sleepSeconds(seconds: number): Promise<void> - Sleep for seconds
• sleepMinutes(minutes: number): Promise<void> - Sleep for minutes
• sleepUntil(unixTimestamp: number): Promise<void> - Sleep until timestamp

Time Utilities

• convertToSeconds(options): number - Converts time units to seconds
• getUnixTimestamp(): number - Gets current Unix timestamp in seconds
• getUnixTimestampMs(): number - Gets current Unix timestamp in milliseconds

Environment Utilities

• isNodeEnvironment(): boolean - Checks if running in Node.js
• isBrowserEnvironment(): boolean - Checks if running in browser
• isWebWorkerEnvironment(): boolean - Checks if running in web worker
• getEnvironment(): string - Gets current environment type
• assertNodeEnvironment(): void - Asserts Node.js environment
• assertBrowserEnvironment(): void - Asserts browser environment

Type Utilities

• Prettify<T> - Utility type for better TypeScript intellisense

Development

# Install dependencies
npm install

# Build the project
npm run build

# Watch mode for development
npm run dev

# Type checking
npm run type-check

# Run tests
npm run test

License

MIT