https://github.com/geisonjr/typefy
Typefy is a versatile and lightweight library for Node.js that simplifies variable type checking.
https://github.com/geisonjr/typefy
node nodejs npm npm-package portfolio typescript typescript-library
Last synced: 5 months ago
JSON representation
Typefy is a versatile and lightweight library for Node.js that simplifies variable type checking.
- Host: GitHub
- URL: https://github.com/geisonjr/typefy
- Owner: GeisonJr
- License: mit
- Created: 2024-03-03T21:44:47.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-06T23:21:45.000Z (about 2 years ago)
- Last Synced: 2025-10-09T01:48:36.519Z (5 months ago)
- Topics: node, nodejs, npm, npm-package, portfolio, typescript, typescript-library
- Language: TypeScript
- Homepage:
- Size: 47.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Typefy Library
Easy to use, fast and lightweight library for Node.js.
[](https://github.com/GeisonJr/typefy/actions/workflows/ci.yaml)
[](https://github.com/GeisonJr/typefy/actions/workflows/cd.yaml)
[](https://github.com/GeisonJr/typefy/blob/main/LICENSE)
[](https://npmjs.com/package/@geisonjr/typefy)
[](https://npmjs.com/package/@geisonjr/typefy)
> [!WARNING]
> This project is under development and is not yet ready for use.
## 🌱 Overview
This library is a collection of functions that help you to check the type of a variable in JavaScript and TypeScript.
## ✨ Features
### Infer the type
- [x] isArray
- [x] isArrayBuffer
- [x] isBigInt
- [x] isBlob
- [x] isBoolean
- [x] isBuffer
- [x] isDate
- [x] isEnum
- [x] isError
- [x] isFunction
- [x] isNothing
- [x] isNull
- [x] isNullOrUndefined
- [x] isNumber
- [x] isObject
- [x] isPromise
- [x] isRegExp
- [x] isString
- [x] isSymbol
- [x] isUndefined
- [x] isURL
- [x] isURLSearchParams
- [x] isVoid
### Check the value
- [x] isFalsy
- [x] isNaNumber
- [x] isTruthy
## 🚀 Tecnologies
The following tools were used in the construction of the project:
- [Jest](https://jestjs.io/)
- [Node.js](https://nodejs.org/en/)
- [TypeScript](https://www.typescriptlang.org/)
## 📦 Install
Use the package manager [npm](https://docs.npmjs.com/),
[yarn](https://yarnpkg.com).
```bash
npm install @geisonjr/typefy
```
```bash
yarn add @geisonjr/typefy
```
## 🏗️ Usage
### Example with True Condition
```typescript
import { isBoolean } from '@geisonjr/typefy'
let test: any = true // false
// Is `true` if the value is a boolean type
if (isBoolean(test)) {
// The intelisense will be recognize the variable as a boolean
console.log('This is a boolean')
}
// Output: This is a boolean
```
### Example with False Condition
```typescript
import { isNumber } from '@geisonjr/typefy'
let test: any = '123'
// Is `true` if the value is a number type
if (isNumber(test)) {
// The intelisense will be recognize the variable as a number
console.log('This is a number')
} else {
// The intelisense will be recognize the variable not as a number
console.log('This is not a number')
}
// Output: This is not a number
```
## 📋 License
This project is under the
[MIT License](https://github.com/geisonjr/typefy/blob/master/LICENSE)