v0.0.0 (#1)

* Adds types and type-guards

* Adds optional and event-emitter

* Exports refactoring

* Updates `package.json` and `README.md`

* Adds documentation

* Enables push on branch

* Updates TODO.md

Author: lilBunnyRabbit

.github/workflows/release.yml

@@ -1,10 +1,9 @@
 name: Release
 
 on:
-  # Disabled for template
-  # push:
-  #   branches:
-  #     - master
+  push:
+    branches:
+      - master
 
   workflow_dispatch:
 

.npmignore

@@ -3,9 +3,11 @@ src/
 tests/
 .github/
 .changeset/
+docs/
 
 .gitignore
 .npmignore
 .prettierrc
 jest.config.js
-tsconfig.json
+tsconfig.json
+TODO.md

README.md

@@ -1,16 +1,20 @@
-# NPM Package Template
+# TypeScript Utils
 
-[![npm version](https://img.shields.io/npm/v/@lilbunnyrabbit/<name>.svg)](https://www.npmjs.com/package/@lilbunnyrabbit/<name>)
-[![npm downloads](https://img.shields.io/npm/dt/@lilbunnyrabbit/<name>.svg)](https://www.npmjs.com/package/@lilbunnyrabbit/<name>)
+[![npm version](https://img.shields.io/npm/v/@lilbunnyrabbit/utils.svg)](https://www.npmjs.com/package/@lilbunnyrabbit/utils)
+[![npm downloads](https://img.shields.io/npm/dt/@lilbunnyrabbit/utils.svg)](https://www.npmjs.com/package/@lilbunnyrabbit/utils)
 
-This repository serves as a template for creating npm packages, simplifying the setup and development process for your npm packages. Replace all the `<name>` with the name of the repository and/or package.
+TypeScript Utils is a comprehensive collection of utilities tailored for [TypeScript](https://www.typescriptlang.org/) 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](https://www.typescriptlang.org/) projects.
+
+## Documentation
+
+Explore the full capabilities of TypeScript Utils and learn how to integrate these utilities into your projects by visiting the [API Documentation](https://lilbunnyrabbit.github.io/typescript-utils/api).
 
 ## Installation
 
 To use this package in your project, run:
 
 ```sh
-npm i @lilbunnyrabbit/<name>
+npm i @lilbunnyrabbit/utils
 ```
 
 ## Development
@@ -22,45 +26,33 @@ This section provides a guide for developers to set up the project environment a
 Clone the repository and install dependencies:
 
 ```sh
-git clone https://github.com/lilBunnyRabbit/npm-package-template.git
-cd npm-package-template
+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.
 
-- **`build`**: Compiles the TypeScript source code to JavaScript, placing the output in the `dist` directory. This script is essential for preparing the package for publication or testing in a built form.
-    ```sh
-    npm run build
-    ```
-- **`test`**: Executes the test suite using Jest. This script is crucial for ensuring that your code meets all defined tests and behaves as expected.
-    ```sh
-    npm test
-    ```
-- **`clean`**: Removes both the `dist` directory and the `node_modules` directory. Useful for resetting the project's state during development or before a fresh install of dependencies.
-    ```sh
-    npm run clean
-    ```
-- **`changeset`**: Manages versioning and changelog generation based on conventional commit messages. This script helps in preparing for a new release by determining which parts of the package need version updates.
-    ```sh
-    npm run changeset
-    ```
-- **`release`**: Publishes the package to npm. It uses `changeset publish` to update package versions and changelogs automatically before publishing. This script streamlines the release process, making it easier to publish new versions of your package.
-    ```sh
-    npm run release
-    ```
+| Script              | Description                                                                                                                                                                                       | Command                 |
+| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
+| **`build`**         | Compiles the [TypeScript](https://www.typescriptlang.org/) 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 [Jest](https://jestjs.io/). Crucial for ensuring that your code meets all defined tests and behaves as expected.                                                    | `npm test`              |
+| **`clean`**         | Removes both the `dist` directory and the `node_modules` directory. Useful for resetting the project's state during development or before a fresh install.                                        | `npm run clean`         |
+| **`changeset`**     | Manages versioning and changelog generation based on conventional commit messages. Helps prepare for a new release by determining which parts of the package need version updates.                | `npm run changeset`     |
+| **`release`**       | Publishes the package to npm. Uses `changeset publish` to automatically update package versions and changelogs before publishing. Streamlines the release process.                                | `npm run release`       |
+| **`generate:docs`** | Generates project documentation using [Typedoc](https://typedoc.org/). Facilitates the creation of comprehensive and accessible API documentation.                                                | `npm run generate:docs` |
 
 These scripts are designed to facilitate the development process, from cleaning and building the project to running tests and releasing new versions. Feel free to use and customize them as needed for your development workflow.
 
 ## Contribution
 
-Contributions are always welcome! Please read the contribution guidelines first.
+Contributions are always welcome! For any enhancements or bug fixes, please open a pull request linked to the relevant issue. If there's no existing issue related to your contribution, feel free to create one.
 
 ## Support
 
-If you find this template useful, consider supporting by buying me a coffee.
+Your support is greatly appreciated! If this package has been helpful, consider supporting by buying me a coffee.
 
 [!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/lilBunnyRabbit)
 

TODO.md

@@ -0,0 +1,2 @@
+- [ ] Include code from `depricated-typescript-utils`
+- [ ] Types testing

docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/api/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.

docs/api/assets/highlight.css

@@ -0,0 +1,99 @@
+:root {
+    --light-hl-0: #795E26;
+    --dark-hl-0: #DCDCAA;
+    --light-hl-1: #000000;
+    --dark-hl-1: #D4D4D4;
+    --light-hl-2: #A31515;
+    --dark-hl-2: #CE9178;
+    --light-hl-3: #AF00DB;
+    --dark-hl-3: #C586C0;
+    --light-hl-4: #0000FF;
+    --dark-hl-4: #569CD6;
+    --light-hl-5: #001080;
+    --dark-hl-5: #9CDCFE;
+    --light-hl-6: #267F99;
+    --dark-hl-6: #4EC9B0;
+    --light-hl-7: #0070C1;
+    --dark-hl-7: #4FC1FF;
+    --light-hl-8: #008000;
+    --dark-hl-8: #6A9955;
+    --light-hl-9: #000000FF;
+    --dark-hl-9: #D4D4D4;
+    --light-hl-10: #098658;
+    --dark-hl-10: #B5CEA8;
+    --light-code-background: #FFFFFF;
+    --dark-code-background: #1E1E1E;
+}
+
+@media (prefers-color-scheme: light) { :root {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
+    --code-background: var(--light-code-background);
+} }
+
+@media (prefers-color-scheme: dark) { :root {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
+    --code-background: var(--dark-code-background);
+} }
+
+:root[data-theme='light'] {
+    --hl-0: var(--light-hl-0);
+    --hl-1: var(--light-hl-1);
+    --hl-2: var(--light-hl-2);
+    --hl-3: var(--light-hl-3);
+    --hl-4: var(--light-hl-4);
+    --hl-5: var(--light-hl-5);
+    --hl-6: var(--light-hl-6);
+    --hl-7: var(--light-hl-7);
+    --hl-8: var(--light-hl-8);
+    --hl-9: var(--light-hl-9);
+    --hl-10: var(--light-hl-10);
+    --code-background: var(--light-code-background);
+}
+
+:root[data-theme='dark'] {
+    --hl-0: var(--dark-hl-0);
+    --hl-1: var(--dark-hl-1);
+    --hl-2: var(--dark-hl-2);
+    --hl-3: var(--dark-hl-3);
+    --hl-4: var(--dark-hl-4);
+    --hl-5: var(--dark-hl-5);
+    --hl-6: var(--dark-hl-6);
+    --hl-7: var(--dark-hl-7);
+    --hl-8: var(--dark-hl-8);
+    --hl-9: var(--dark-hl-9);
+    --hl-10: var(--dark-hl-10);
+    --code-background: var(--dark-code-background);
+}
+
+.hl-0 { color: var(--hl-0); }
+.hl-1 { color: var(--hl-1); }
+.hl-2 { color: var(--hl-2); }
+.hl-3 { color: var(--hl-3); }
+.hl-4 { color: var(--hl-4); }
+.hl-5 { color: var(--hl-5); }
+.hl-6 { color: var(--hl-6); }
+.hl-7 { color: var(--hl-7); }
+.hl-8 { color: var(--hl-8); }
+.hl-9 { color: var(--hl-9); }
+.hl-10 { color: var(--hl-10); }
+pre, code { background: var(--code-background); }