diff options
| author | Akshay Nair <phenax5@gmail.com> | 2023-01-14 18:16:41 +0530 |
|---|---|---|
| committer | Akshay Nair <phenax5@gmail.com> | 2023-01-14 18:16:41 +0530 |
| commit | e75a5a15912b8f297fe9c9747f574486d6c4e334 (patch) | |
| tree | 603cd3b9fa68e6e0bd700fe66fede80e9ae657c9 /docs/interfaces/test.Assert.md | |
| parent | 78e384c2f32996478edced59c837a348dec77e57 (diff) | |
| download | ts-types-lang-e75a5a15912b8f297fe9c9747f574486d6c4e334.tar.gz ts-types-lang-e75a5a15912b8f297fe9c9747f574486d6c4e334.zip | |
chore: adds some docs
Diffstat (limited to 'docs/interfaces/test.Assert.md')
| -rw-r--r-- | docs/interfaces/test.Assert.md | 37 |
1 files changed, 16 insertions, 21 deletions
diff --git a/docs/interfaces/test.Assert.md b/docs/interfaces/test.Assert.md index b066763..f03e945 100644 --- a/docs/interfaces/test.Assert.md +++ b/docs/interfaces/test.Assert.md @@ -4,34 +4,29 @@ [test](../modules/test.md).Assert -## Type parameters - -| Name | Type | -| :------ | :------ | -| `_B` | extends `boolean` | - -## Hierarchy - -- [`Effect`](effect.Effect.md) +Assert a boolean expression is true - ↳ **`Assert`** - -## Table of contents +**`Throws`** -### Properties +if false -- [output](test.Assert.md#output) +**`Example`** -## Properties +Here's an example checking if `SomeValue` is not equal to [1,2,3] +Uses - [Not](../modules/util.md#not), [Equals](../modules/util.md#equals) -### output +```ts +Assert<Not<Equals<SomeValue, [1, 2, 3]>>> +``` -• **output**: `unknown` +## Type parameters -#### Inherited from +| Name | Type | Description | +| :------ | :------ | :------ | +| `_B` | extends `boolean` | The boolean value to assert | -[Effect](effect.Effect.md).[output](effect.Effect.md#output) +## Hierarchy -#### Defined in +- [`Effect`](effect.Effect.md) -[effect.ts:2](https://github.com/phenax/ts-types-runtime-environment/blob/6c7b4f3/stdlib/effect.ts#L2) + ↳ **`Assert`** |