Security News
Combatting Alert Fatigue by Prioritizing Malicious Intent
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
@brillout/libassert
Advanced tools
@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 3,964 weekly downloads. As such, @brillout/libassert popularity was classified as popular.
We found that @brillout/libassert 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
In 2023, data breaches surged 78% from zero-day and supply chain attacks, but developers are still buried under alerts that are unable to prevent these threats.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.