Skip to content
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.

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

Sweep: Update the docstrings and comments in sdks/ts/src/utils/invariant.ts to fix any issues and mismatch between the comment and associated code #237

Merged
merged 2 commits into from
Apr 18, 2024
Merged
Changes from all commits
Commits
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
6 changes: 6 additions & 0 deletions sdks/ts/src/utils/invariant.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
/**
* Ensures that a condition is met, throwing a custom error message if not.
* @param condition The condition to test. If falsy, an error is thrown.
* @param message Optional. The error message to throw if the condition is not met. Defaults to "Invariant Violation".
*/
export function invariant(
condition: any,
message: string = "Invariant Violation",
): void {
// Throw an error with the provided message if the condition is falsy
if (!condition) {
throw new Error(message);
}
Expand Down
Loading