Git Product home page Git Product logo

typechecker's Introduction

๐Ÿ” TypeChecker

An advanced Type Checker that checks and handles type for the param name on your function built to make nodejs module creating easy. Both TypeScript and JavaScript.

๐Ÿš€ Features

  • Easy to code
  • Zero dependencies
  • Light weight module
  • Make type-checking easy
  • Error handler

๐Ÿ’ป Installation

NPM:

npm install type-checker-handler

Yarn:

yarn add type-checker-handler

๐Ÿ“ How to use

Using Type Checker is very easy Only 1-2 lines code

Example usage (TypeScript):

import { JsTypes, typeCheck } from "type-checker-handler";

const aFunction = (msg: string, ...optional: any[]) => {
  typeCheck({ paramName: msg, expectedType: JsTypes.String });
  let output = msg;

  if (optional.length > 0) {
    output += optional.join(" ");
  }

  return output;
};

export { aFunction };

If the user provided parameter type is not same as the function's required type it will throw a `TypeError`

Example Usage (JavaScript):

const { JsTypes, typeCheckJs } = require("type-checker-handler");

const aFunction = (msg, ...optional) => {
  typeCheckJs({
    paramName: msg,
    paramType: JsTypes.String,
    expectedType: JsTypes.String,
  });
  let output = msg;

  if (optional.length > 0) {
    output += optional.join(" ");
  }

  return output;
};

export { aFunction };

Not 1-2 line(s) of code?

The code given in the example is full code.

The exact type-checking code is:

typeCheck({ paramName: msg, expectedType: JsTypes.String });

And

typeCheckJs({
  paramName: msg,
  paramType: JsTypes.String,
  expectedType: JsTypes.String,
});

It is same for both TypeScript and JavaScript

typechecker's People

Contributors

codeblitz97 avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.