@brillout/libassert
Advanced tools
Weekly downloads
Readme
@brillout/libassert
Tiny zero-dependency tool for library authors to create assertion functions with clean strack traces.
Error.stackTraceLimit = Infinity;
only for assertion errors.)import { newError } from "@brillout/libassert";
export { assert };
function assert(condition: unknown): asserts condition {
if (condition) {
return;
}
const err = newError(
`[${libName}][Internal Error] Something unexpected happened, please open a GitHub issue.`;
);
throw err;
}
Calling newError(errorMessage)
is the same than new Error(errorMessage)
except that:
errorMessage
is forbidden to contain new lines.You can create all kinds of assertion functions, such as assertUsage
or assertWarning
:
import { newError } from "@brillout/libassert";
export { assert, assertUsage, assertWarning };
const libName = "My Awesome Library";
// Assertions that are expected to always be true (also known as "invariants")
function assert(condition: unknown): asserts condition {
if (condition) {
return;
}
const err = newError(
`[${libName}][Internal Error] Something unexpected happened, please open a GitHub issue.`;
);
throw err;
}
// Wrong usage of your library
function assertUsage(
condition: unknown,
errorMessage: string
): asserts condition {
if (condition) {
return;
}
const err = newError(prefix: `[${libName}][Wrong Usage] ${errorMessage}`);
throw err;
}
// Something unexpected happened but it is non-critical and doesn't
// warrant interrupting code execution.
function assertWarning(condition: unknown, errorMessage: string): void {
if (condition) {
return;
}
const err = newError(`[${libName}][Warning] ${errorMessage}`);
console.warn(err);
}
FAQs
Assertions for library authors.
The npm package @brillout/libassert receives a total of 395 weekly downloads. As such, @brillout/libassert popularity was classified as not popular.
We found that @brillout/libassert demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.