TypeScript Utils

TypeScript Utils is a comprehensive collection of utilities tailored for TypeScript development, crafted to support a broad spectrum of projects and packages. This toolkit is designed to enhance developer productivity and code quality, offering a diverse array of utilities ranging from custom types and type guards to an extensive set of tools for event management, data manipulation, and more. Whether you're streamlining your development workflow, ensuring type safety, or facilitating event-driven architectures, TypeScript Utils provides the essential building blocks to elevate your TypeScript projects.

Documentation

Explore the full capabilities of TypeScript Utils and learn how to integrate these utilities into your projects by visiting the API Documentation.

Installation

To use this package in your project, run:

npm i @lilbunnyrabbit/utils

Development

This section provides a guide for developers to set up the project environment and utilize various npm scripts defined in the project for efficient development and release processes.

Setting Up

Clone the repository and install dependencies:

git clone https://github.com/lilBunnyRabbit/typescript-utils.git
cd typescript-utils
npm install

NPM Scripts

The project includes several npm scripts to streamline common tasks such as building, testing, and cleaning up the project.

Script	Description	Command
build	Compiles the TypeScript source code to JavaScript, placing the output in the dist directory. Essential for preparing the package for publication or testing.	npm run build
test	Executes the test suite using . Crucial for ensuring that your code meets all defined tests and behaves as expected.