utils: Separate assertDefined and assertDefinedAndNotNull

This commit is contained in:
willclarktech 2021-01-14 13:25:20 +00:00
parent 9651c5e3a5
commit 7d7d350813
No known key found for this signature in database
GPG Key ID: 551A86E2E398ADF7
5 changed files with 59 additions and 3 deletions

View File

@ -1,6 +1,55 @@
import { assertDefinedAndNotNull } from "./assert";
import { assertDefined, assertDefinedAndNotNull } from "./assert";
describe("assert", () => {
describe("assertDefined", () => {
it("passes for simple values", () => {
{
const value: number | undefined = 123;
assertDefined(value);
expect(value).toEqual(123);
}
{
const value: string | undefined = "abc";
assertDefined(value);
expect(value).toEqual("abc");
}
});
it("passes for falsy values", () => {
{
const value: number | undefined = 0;
assertDefined(value);
expect(value).toEqual(0);
}
{
const value: string | undefined = "";
assertDefined(value);
expect(value).toEqual("");
}
{
const value: null | undefined = null;
assertDefined(value);
expect(value).toBeNull();
}
});
it("throws for undefined values", () => {
{
const value: number | undefined = undefined;
expect(() => assertDefined(value)).toThrowError("value is undefined");
}
{
let value: string | undefined;
expect(() => assertDefined(value)).toThrowError("value is undefined");
}
});
it("throws with custom message", () => {
const value: number | undefined = undefined;
expect(() => assertDefined(value, "Bug in the data source")).toThrowError("Bug in the data source");
});
});
describe("assertDefinedAndNotNull", () => {
it("passes for simple values", () => {
{

View File

@ -5,6 +5,12 @@ export function assert(condition: any, msg?: string): asserts condition {
}
}
export function assertDefined<T>(value: T | undefined, msg?: string): asserts value is T {
if (value === undefined) {
throw new Error(msg ?? "value is undefined");
}
}
export function assertDefinedAndNotNull<T>(value: T | undefined | null, msg?: string): asserts value is T {
if (value === undefined || value === null) {
throw new Error(msg ?? "value is undefined or null");

View File

@ -1,4 +1,4 @@
export { arrayContentEquals } from "./arrays";
export { assert, assertDefinedAndNotNull } from "./assert";
export { assert, assertDefined, assertDefinedAndNotNull } from "./assert";
export { sleep } from "./sleep";
export { isNonNullObject, isUint8Array } from "./typechecks";

View File

@ -1,4 +1,5 @@
export declare function assert(condition: any, msg?: string): asserts condition;
export declare function assertDefined<T>(value: T | undefined, msg?: string): asserts value is T;
export declare function assertDefinedAndNotNull<T>(
value: T | undefined | null,
msg?: string,

View File

@ -1,4 +1,4 @@
export { arrayContentEquals } from "./arrays";
export { assert, assertDefinedAndNotNull } from "./assert";
export { assert, assertDefined, assertDefinedAndNotNull } from "./assert";
export { sleep } from "./sleep";
export { isNonNullObject, isUint8Array } from "./typechecks";