Skip to content

Commit

Permalink
docs: Fix TSDoc descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
davidkarolyi committed Mar 10, 2022
1 parent d0ca035 commit 0c2e522
Show file tree
Hide file tree
Showing 38 changed files with 190 additions and 188 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -176,4 +176,5 @@ All guards can be imported as a single module, which enables tree-shaking:

```ts
import TString from "tguard/guards/TString";
import { GuardedType } from "tguard/Guard";
```
1 change: 1 addition & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,4 +178,5 @@ All guards can be imported as a single module, which enables tree-shaking:

```ts
import TString from "tguard/guards/TString";
import { GuardedType } from "tguard/Guard";
```
14 changes: 7 additions & 7 deletions docs/classes/Guard.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

# Class: Guard<T\>

An abstract class, which has an `isValid` method, and a `name` property, which represents the name of the guarded type.
An abstract class, which is the parent class of all Guards. (Names starting with a `T`)

⚠️ Don't use this directly to create custom guards, use `TValidate` instead.

## Type parameters

| Name |
| :------ |
| `T` |
| Name | Description |
| :------ | :------ |
| `T` | Guarded type |

## Table of contents

Expand Down Expand Up @@ -47,7 +47,7 @@ An abstract class, which has an `isValid` method, and a `name` property, which r

#### Defined in

[src/Guard.ts:9](https://github.com/davidkarolyi/tguard/blob/9309bca/src/Guard.ts#L9)
[src/Guard.ts:11](https://github.com/davidkarolyi/tguard/blob/d0ca035/src/Guard.ts#L11)

## Methods

Expand All @@ -67,7 +67,7 @@ An abstract class, which has an `isValid` method, and a `name` property, which r

#### Defined in

[src/Guard.ts:11](https://github.com/davidkarolyi/tguard/blob/9309bca/src/Guard.ts#L11)
[src/Guard.ts:13](https://github.com/davidkarolyi/tguard/blob/d0ca035/src/Guard.ts#L13)

___

Expand All @@ -87,4 +87,4 @@ value is T

#### Defined in

[src/Guard.ts:10](https://github.com/davidkarolyi/tguard/blob/9309bca/src/Guard.ts#L10)
[src/Guard.ts:12](https://github.com/davidkarolyi/tguard/blob/d0ca035/src/Guard.ts#L12)
6 changes: 3 additions & 3 deletions docs/classes/ValidationError.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ Error.constructor

#### Defined in

[src/errors.ts:5](https://github.com/davidkarolyi/tguard/blob/9309bca/src/errors.ts#L5)
[src/errors.ts:5](https://github.com/davidkarolyi/tguard/blob/d0ca035/src/errors.ts#L5)

## Properties

Expand All @@ -58,7 +58,7 @@ Error.constructor

#### Defined in

[src/errors.ts:3](https://github.com/davidkarolyi/tguard/blob/9309bca/src/errors.ts#L3)
[src/errors.ts:3](https://github.com/davidkarolyi/tguard/blob/d0ca035/src/errors.ts#L3)

___

Expand Down Expand Up @@ -96,7 +96,7 @@ ___

#### Defined in

[src/errors.ts:2](https://github.com/davidkarolyi/tguard/blob/9309bca/src/errors.ts#L2)
[src/errors.ts:2](https://github.com/davidkarolyi/tguard/blob/d0ca035/src/errors.ts#L2)

___

Expand Down
Loading

0 comments on commit 0c2e522

Please sign in to comment.