@lerado/typescript-toolbox

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

This library is a comprehensive collection of TypeScript utilities that can be used to simplify and streamline TypeScript projects. It includes a wide range of functions, classes, and interfaces that make it easier to work with common data types, manipulate arrays and objects, and manage other aspects of the language. Additionally, the library is designed to be easy to use and integrate into existing projects, making it a valuable resource for TypeScript developers of all levels.

(back to top)

Built With

• 

(back to top)

Getting Started

To start using this library in your project, follow these simple example steps.

Prerequisites

You basically just need npm or yarn:

• npm

  npm install npm@latest -g
  

• yarn

  npm install yarn@latest -g
  

Installation

Just a single command required. Depending on which package manager you use.

• npm

  npm install @lerado/typescript-toolbox
  

• yarn

  yarn add @lerado/typescript-toolbox
  

(back to top)

Usage

Import an use any function, decorator, etc...

import { objectToFlatString } from '@lerado/typescript-toolbox';

objectToFlatString({ id: 123, name: 'Mr. Smith', age: 23 });
// => to 123mr. smith23.

Please refer to the documentation for more.

(back to top)

Roadmap

• Release v1.0.0 on npm
• Configure Github actions for CI/CD

  Contributing

  Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  We use the Git workflow and Commitizen for our development cycles and releases. We strongly recommend you use it too with your contributions.

  If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your feature/hotfix Branch (git checkout -b (feature|hotfix)/branch-name)
  3. Commit your Changes (git commit -m <COMMITIZEN FRIENDLY MESSAGE>)
  4. Push to the Branch (git push origin <YOUR BRANCH>)
  5. Open a Pull Request

  (back to top)

  License

  Distributed under the MIT License. See LICENSE for more information.

  (back to top)

  Contact

  Darel Ngogang - @JeSuisLerado - darel.ngogang@gmail.com

  Project Link: https://github.com/Lerado/typescript-toolbox

  (back to top)

  Acknowledgments

  • TypeScript Starter template
  • How to create and publish a TypeScript library

  (back to top)