Package Exports

typescript-type-checker
typescript-type-checker/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (typescript-type-checker) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

typescript-type-checker

typescript-type-checker is Runtime Type Checker for Typescript.

It generates runtime type checking sanitizer script for Typescript.

typescript-type-checker supports all default types, arrays, and custom types.

How to install

npm install typescript-type-checker

How to use

You can use typescript-type-checker both commandline and script.

Script usage

import { buildScript } from "typescript-type-checker";

const srcDir = "./src/lib";
const outputPath = "./out.ts";
const strictMode = false;

buildScript(srcDir, outputPath, strictMode);

Commandline usage

args:

--src: Input directory which contains .ts files

--out: Output directory which sanitizer script will be saved to

--strict: Whether use strict mode. In strict mode, script does not check string value can be converted to number or boolean

example:
$ npx typescript-type-checker --src "./src/lib" --out "./out/sanitizer.ts" --strict

Then you can get sanitizer script at "./out/sanitizer.ts".

Example

./src/lib/example.ts

export interface Foo {
    number: number;
    boolean: boolean;
    maybeString?: string;
    bar: Bar;
}

interface Bar {
    numbers: number[];
}

With strict mode

function sanitizeFoo(checker: any) {
    if (
        typeof checker.number != "number" ||
        typeof checker.boolean != "boolean" ||
        (checker.maybeString != undefined &&
            typeof checker.maybeString != "string") ||
        !sanitizeBar(checker.bar)
    ) {
        return false;
    }
    return true;
}

function sanitizeBar(checker: any) {
    if (!sanitizenumberArray(checker.numbers)) {
        return false;
    }
    return true;
}

function sanitizenumberArray(checker: any) {
    if (!Array.isArray(checker)) {
        return false;
    }

    for (let i = 0; i < checker.length; i++) {
        if (typeof checker[i] != "number") {
            return false;
        }
    }
    return true;
}

Without strict mode

function sanitizeFoo(checker: any) {
    if (
        typeof checker.number == "string" &&
        Boolean(checker.number.trim()) &&
        !Number.isNaN(Number(checker.number))
    ) {
        checker.number = Number(checker.number);
    }

    if (
        typeof checker.boolean == "string" &&
        (checker.boolean == "true" || checker.boolean == "false")
    ) {
        checker.boolean = checker.boolean == "true";
    }

    if (
        typeof checker.number != "number" ||
        typeof checker.boolean != "boolean" ||
        (checker.maybeString != undefined &&
            typeof checker.maybeString != "string") ||
        !sanitizeBar(checker.bar)
    ) {
        return false;
    }
    return true;
}

function sanitizeBar(checker: any) {
    if (!sanitizenumberArray(checker.numbers)) {
        return false;
    }
    return true;
}

function sanitizenumberArray(checker: any) {
    if (!Array.isArray(checker)) {
        return false;
    }

    for (let i = 0; i < checker.length; i++) {
        if (typeof checker[i] != "number") {
            return false;
        }
    }
    return true;
}