0.0.4 • Published 2 years ago
typeguru v0.0.4
TypeGuru
Important: This project is still in development and not ready for production use.
This is a collection of utility functions for TypeScript projects, designed to help you write clean, efficient, and maintainable code.
Tech Stack
This project is built with the following technologies:
- TypeScript: a typed superset of JavaScript that compiles to plain JavaScript
- Jest: a testing framework for JavaScript and TypeScript projects
- Yarn: a fast, reliable, and secure dependency manager for Node.js
Installation
To install this project, run the following command:
yarn add @nilsvennemann/typeguru
Usage
To use this project, import the functions you need:
import { isObjectLiteral, isPlainObject } from '@nilsvennemann/typeguru'
const isObject = isObjectLiteral({}) // true
const isPlain = isPlainObject({}) // true
Contributing
To contribute to this project, follow these steps:
- Fork this repository.
- Create a branch:
git checkout -b <branch_name>
. - Make your changes and commit them:
git commit -m '<commit_message>'
- Push to the original branch:
git push origin <project_name>/<location>
- Create the pull request.
- Wait for the pull request to be reviewed and merged.
- Celebrate! :tada: