DT Utils

A fully typed utility library for TypeScript projects.

Features

• 🔒 Fully Typed: Complete TypeScript support with strict type checking
• 🚀 Modern: Built with modern JavaScript/TypeScript features
• 📦 Tree-shakable: Only import what you need
• 🧪 Well Tested: Comprehensive test coverage
• 📚 Well Documented: JSDoc comments for all functions

Installation

npm install dt-utils

Usage

import { debounce, throttle, deepClone } from "dt-utils";

// Debounce a function
const debouncedSearch = debounce((query: string) => {
  console.log("Searching for:", query);
}, 300);

// Throttle a function
const throttledScroll = throttle(() => {
  console.log("Scroll event");
}, 100);

// Deep clone an object
const original = { a: 1, b: { c: 2 } };
const cloned = deepClone(original);

Development

Prerequisites

• Node.js >= 16.0.0
• npm

Setup

1. Clone the repository
2. Install dependencies:

   npm install

Available Scripts

• npm run build - Build the library
• npm run dev - Watch mode for development
• npm test - Run tests
• npm run test:watch - Run tests in watch mode
• npm run lint - Run ESLint
• npm run lint:fix - Fix ESLint issues
• npm run clean - Clean build directory

Building

npm run build

This will compile TypeScript to JavaScript and generate type definitions in the dist/ directory.

Testing

npm test

Publishing

npm publish

API Documentation

Functions

debounce<T extends (...args: any[]) => any>(func: T, wait: number): T

Creates a debounced version of a function.

throttle<T extends (...args: any[]) => any>(func: T, limit: number): T

Creates a throttled version of a function.

deepClone<T>(obj: T): T

Creates a deep clone of an object.

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests for new functionality
5. Run tests and linting
6. Submit a pull request

License

MIT