ts-invariant

Install

npm i ts-invariant

yarn add ts-invariant

pnpm add ts-invariant

TypeScript implementation of invariant(condition, message)

const verbosityLevels: readonly ['debug', 'log', 'warn', 'error', 'silent'];

invariant: typeof invariant;

setVerbosity: (level: VerbosityLevel) => VerbosityLevel;

class InvariantError extends Error {}

constructor(message?: string | number);

framesToPop: number;

name: string;

type ConsoleMethodName = Exclude<VerbosityLevel, 'silent'>;

type VerbosityLevel = typeof verbosityLevels[number];

namespace invariant {}

const debug: {
    (...data: any[]): void;
    (message?: any, ...optionalParams: any[]): void;
};

const error: {
    (...data: any[]): void;
    (message?: any, ...optionalParams: any[]): void;
};

const log: {
    (...data: any[]): void;
    (message?: any, ...optionalParams: any[]): void;
};

const warn: {
    (...data: any[]): void;
    (message?: any, ...optionalParams: any[]): void;
};

No peer dependencies.

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/ts-invariant.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/ts-invariant)

HTML

<a href="https://www.jsdocs.io/package/ts-invariant"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>