Skip to content

allow asserting with a dynamic message #862

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ianmacartney wants to merge 1 commit into
base: main
Choose a base branch
from
Open

allow asserting with a dynamic message #862

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions packages/convex-helpers/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,11 +165,15 @@ export type Equals<X, Y> =
* assert(x);
* // x is now of type string
* ```
* You can also provide a function, to avoid doing expensive string templating.
* @param arg A value to assert the truthiness of.
* @param message An optional message to throw if the value is not truthy.
* @param message An optional message to throw if the value is not truthy, or a function to generate the message.
*/
export function assert(value: unknown, message?: string): asserts value {
export function assert(
value: unknown,
message?: string | (() => string),
): asserts value {
if (!value) {
throw new Error(message);
throw new Error(typeof message === "function" ? message() : message);
}
}
Loading