typpy

What is typpy?

Typpy is a lightweight utility for checking JavaScript types. It provides a simple and consistent API to determine the type of a given value, making it easier to handle type checking in your code.

What are typpy's main functionalities?

Type Checking

Typpy allows you to check the type of a given value. It returns a string representing the type, such as 'number', 'string', 'object', 'array', 'null', 'undefined', or 'function'.

const typpy = require('typpy');

console.log(typpy(42)); // 'number'
console.log(typpy('Hello')); // 'string'
console.log(typpy({})); // 'object'
console.log(typpy([])); // 'array'
console.log(typpy(null)); // 'null'
console.log(typpy(undefined)); // 'undefined'
console.log(typpy(() => {})); // 'function'

Type Comparison

Typpy provides a method to compare a value against a specified type. It returns true if the value matches the type, and false otherwise.

const typpy = require('typpy');

console.log(typpy.is(42, 'number')); // true
console.log(typpy.is('Hello', 'string')); // true
console.log(typpy.is({}, 'object')); // true
console.log(typpy.is([], 'array')); // true
console.log(typpy.is(null, 'null')); // true
console.log(typpy.is(undefined, 'undefined')); // true
console.log(typpy.is(() => {}, 'function')); // true

Custom Type Checking

Typpy can also handle custom types. When you create an instance of a custom class, Typpy will return the class name as the type.

const typpy = require('typpy');

class CustomType {}
const customInstance = new CustomType();

console.log(typpy(customInstance)); // 'customtype'
console.log(typpy.is(customInstance, 'customtype')); // true

Other packages similar to typpy

typeof

The 'typeof' package provides a simple way to get the type of a value. It is similar to Typpy but offers a more minimalistic approach. Unlike Typpy, it does not support custom type checking.

type-detect

The 'type-detect' package is another utility for type checking in JavaScript. It offers more detailed type detection compared to Typpy, including support for detecting specific object types like 'RegExp' and 'Date'.

is

The 'is' package provides a comprehensive set of type-checking functions. It is more feature-rich compared to Typpy, offering additional checks for types like 'boolean', 'error', and 'buffer'.

README

typpy

A better typeof for JavaScript.

:cloud: Installation

$ npm i --save typpy

:clipboard: Example

// Dependencies
var Typpy = require("typpy");

console.log(Typpy(0));
// => "number"

console.log(Typpy("", String));
// => true

console.log(Typpy.is(null, "null"));
// => true

console.log(Typpy.get([]));
// => Array

console.log(Typpy({}, true));
// => "object"

console.log(Typpy({}, Object));
// => true

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help from me, you can use Codementor. :rocket:

:memo: Documentation

Typpy(input, target)

Gets the type of the input value or compares it with a provided type.

Usage:

Typpy({}) // => "object"
Typpy(42, Number); // => true
Typpy.get([], "array"); => true

Params

• Anything input: The input value.
• Constructor|String target: The target type. It could be a string (e.g. "array") or a constructor (e.g. Array).

Return

• String|Boolean It returns true if the input has the provided type target (if was provided), false if the input type does not have the provided type target or the stringified type of the input (always lowercase).

Typpy.is(input, target)

Checks if the input value has a specified type.

Params

• Anything input: The input value.
• Constructor|String target: The target type. It could be a string (e.g. "array") or a constructor (e.g. Array).

Return

• Boolean true, if the input has the same type with the target or false otherwise.

Typpy.get(input, str)

Gets the type of the input value. This is used internally.

Params

• Anything input: The input value.
• Boolean str: A flag to indicate if the return value should be a string or not.

Return

• Constructor|String The input value constructor (if any) or the stringified type (always lowercase).

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:

• —You can make one-time donations via PayPal. I'll probably buy a coffee tea. :tea:

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! :heart:

:dizzy: Where is this library used?

If you are using this library in one of your projects, add it in this list. :sparkles:

• animato—Simple way to animate anything (even simple values).
• asyncer.js—Run groups of (a)sync functions.
• auto-parse (by Green Pioneer)—auto-parse any value you happen to send in (String, Number, Boolean,Array, Object, Function, undefined and null). You send it we will try to find a way to parse it.support sending in a string of what type (e.g. boolean) or constructor (e.g. Boolean)
• babel-it—Babelify your code before npm publish.
• barbe—Like mustache, but simple, tiny and fast.
• blah—A command line tool to optimize the repetitive actions.
• bloggify-ajs-renderer—ajs renderer for Bloggify.
• bloggify-flexible-router (by Bloggify)—A flexible router for Bloggify apps.
• bug-killer—Simple way to log messages in stdout or other stream.
• cli-circle—Generate ASCII circles with NodeJS.
• cli-gh-cal—GitHub like calendar graphs in command line.
• color-it—Flat colors for your Node.js strings.
• couleurs—Add some color and styles to your Node.JS strings.
• deffy—Small and fast library to set default values.
• diable—Daemonize the things out.
• dom-repeater—Render lists in DOM easily.
• elm-select—Select DOM elements and optionally call a function.
• engine-builder (by jillix)—Engine composition parser.
• engine-flow-types (by jillix)—Low level library providing Engine flow types.
• engine-parser (by jillix)—Engine composition parser.
• enny (by jillix)—Generate Engine compositions from human-readable inputs.
• err—A tiny library to create custom errors in JavaScript.
• exec-limiter—Limit the shell execution commands to calls same time.
• flattenize—An experiment for converting images in flat equivalents.
• gh-repos—Get one or all the owner repositories from GitHub.
• ghcal—See the GitHub contributions calendar of a user in the command line.
• ghosty—A wrapper around PhantomJS, downloading the Phantom binary.
• git-stats—Local git statistics including GitHub-like contributions calendars.
• git-stats-importer—Imports your commits from a repository into git-stats history.
• limit-it—Run in parallel as many functions you want, but not more than functions at the time.
• obj-flatten—Convert nested objects in flatten ones.
• page-changed—Call a function when the page body is changed.
• regarde—A tiny tool and library to watch commands.
• scrape-it—A Node.js scraper for humans.
• tilda—Tiny module for building command line tools.
• transformer—Transform data using synchronous and asynchronous functions.
• ul—A minimalist utility library.
• validify—Validation made easy.
• write-file-p—Create the directory structure and then create the file.

:scroll: License

MIT © Ionică Bizău