ts-invariant
Advanced tools
Package description
The ts-invariant package provides utility functions for asserting invariants within TypeScript applications. It is designed to throw errors when certain conditions are not met, which can be useful for catching programming errors and enforcing certain constraints at runtime.
Invariant
The invariant function is used to assert that a condition is true. If the condition is false, it will throw an error with the provided error message.
import { invariant } from 'ts-invariant';
invariant(condition, 'Expected condition to be true');Invariant.warn
The invariant.warn function is used to log a warning message to the console. It does not throw an error.
import { invariant } from 'ts-invariant';
invariant.warn('This is a warning message');Invariant.error
The invariant.error function is used to log an error message to the console. It does not throw an error.
import { invariant } from 'ts-invariant';
invariant.error('This is an error message');The 'assert' module is a built-in Node.js package that provides a simple set of assertion tests. It is similar to ts-invariant in that it is used to test invariants, but it is not specifically tailored for TypeScript and does not provide the same logging capabilities.
Chai is a BDD/TDD assertion library for Node.js and the browser that can be paired with any JavaScript testing framework. It offers a richer set of assertions than ts-invariant, including property checks, deep equality, and chainable assertions, making it more suitable for complex testing scenarios.
Prop-types is a library for runtime type checking for React props and similar objects. While it serves a different purpose than ts-invariant, it also provides a way to enforce type constraints at runtime, which is a form of invariant checking.
Readme
TypeScript implementation of
invariant(condition, message).
Supports invariant.log, invariant.warn, and invariant.error, which
wrap console methods of the same name, and may be stripped in production
by rollup-plugin-invariant.
The verbosity of these methods can be globally reconfigured using the
setVerbosity function:
import { setVerbosity } from "ts-invariant";
setVerbosity("log"); // display all messages (default)
setVerbosity("warn"); // display only warnings and errors
setVerbosity("error"); // display only errors
setVerbosity("silent"); // display no messages
FAQs
TypeScript implementation of invariant(condition, message)
The npm package ts-invariant receives a total of 4,466,802 weekly downloads. As such, ts-invariant popularity was classified as popular.
We found that ts-invariant demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.