From e75a5a15912b8f297fe9c9747f574486d6c4e334 Mon Sep 17 00:00:00 2001 From: Akshay Nair Date: Sat, 14 Jan 2023 18:16:41 +0530 Subject: chore: adds some docs --- stdlib/test.ts | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) (limited to 'stdlib/test.ts') diff --git a/stdlib/test.ts b/stdlib/test.ts index fd1045b..a3b1d80 100644 --- a/stdlib/test.ts +++ b/stdlib/test.ts @@ -2,11 +2,21 @@ import { Do, Effect, Kind1 } from './effect' import { Throw, Try } from './exception' import { Equals } from './util' -export interface Config { - // compileTimeTestFailures: false - // stopAtFailure: true // TODO: stopAtFailure -} - +/** + * Assert a boolean expression is true + * + * @typeParam _B - The boolean value to assert + * + * @throws {"assertion error"} if false + * + * @example + * Here's an example checking if `SomeValue` is not equal to [1,2,3] + * Uses - {@link util.Not}, {@link util.Equals} + * + * ```ts + * Assert>> + * ``` + */ export interface Assert<_B extends boolean> extends Effect {} export interface Test<_m extends string, _effs extends Effect[]> -- cgit v1.3.1