Skip to content

Commit

Permalink
[dsch] minor docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
DScheglov committed Mar 19, 2021
1 parent 2e49bcd commit 256ab16
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 15 deletions.
6 changes: 3 additions & 3 deletions docs/1-engine.md
Expand Up @@ -50,7 +50,7 @@ const casterFn: CasterFn<number> = function yearOf21stCentury(
```

<a name="2-caster"></a>
## 2. Caster&lt;T&gt; <sup>type</sup>
## 2. Caster&lt;T&gt; <sup>`type`</sup>

The extenstion of the `CasterFn<T>` that contains properties and methods to build other types,
including by mapping casted data.
Expand Down Expand Up @@ -137,8 +137,8 @@ someStr(null); // throws a TypeError
## 3. casterApi&lt;T&gt; <sup>`fn`</sup>

<a name="4-create-caster"></a>
## 4. createCaster&lt;T&gt; <sup>fn</sup>
## 4. createCaster&lt;T&gt; <sup>`fn`</sup>


<a name="5-validate"></a>
## 5. validate&lt;T&gt; <sup>fn</sup>
## 5. validate&lt;T&gt; <sup>`fn`</sup>
24 changes: 12 additions & 12 deletions docs/README.md
Expand Up @@ -6,10 +6,10 @@ Runtime type checking for Typescript and JavaScript projects.

1. [Type Checking Engine](./1-engine.md)
1. [CasterFn&lt;T&gt; <sup>`type`</sup>](./1-engine.md#1-caster-fn)
2. [Caster&lt;T&gt; <sup>type</sup>](./1-engine.md#2-caster)
2. [Caster&lt;T&gt; <sup>`type`</sup>](./1-engine.md#2-caster)
3. [casterApi&lt;T&gt; <sup>`fn`</sup>](./1-engine.md#3-caster-api)
4. [createCaster&lt;T&gt; <sup>fn</sup>](./1-engine.md#4-create-cater)
5. [validate <sup>fn</sup>](./1-engine.md#5-validate)
4. [createCaster&lt;T&gt; <sup>`fn`</sup>](./1-engine.md#4-create-cater)
5. [validate <sup>`fn`</sup>](./1-engine.md#5-validate)

2. [Primitive Type Casters](./2-types.md#1-primitives)
1. [boolean](./2-types.md$1-1-boolean)
Expand Down Expand Up @@ -37,17 +37,17 @@ Runtime type checking for Typescript and JavaScript projects.
6. [Recursive Type Casters](./2-types.md)

7. [Type Composition](./3-operations.md)
1. [prod <sup>fn</sup>](./3-operations.md#1-prod)
2. [union <sup>fn</sup>](./3-operations.md#2-union)
1. [prod <sup>`fn`</sup>](./3-operations.md#1-prod)
2. [union <sup>`fn`</sup>](./3-operations.md#2-union)

8. [Narrowing Types](./4-restrictions.md#1-rules)
1. [Predicate&lt;T&gt; <sup>type</sup>](./4-restrictions.md#1-1-predicate)
2. [RuleFn&lt;T&gt; <sup>type</sup>](./4-restrictions.md#1-2-rulefn)
3. [toBe <sup>fn</sup>](./4-restrictions.md#1-3-tobe)
4. [notToBe <sup>fn</sup>](./4-restrictions.md#1-4-nottobe)
5. [and <sup>fn</sup>](./4-restrictions.md#1-5-and)
6. [or <sup>fn</sup>](./4-restrictions.md#1-6-or)
7. [not <sup>fn</sup>](./4-restrictions.md#1-7-not)
1. [Predicate&lt;T&gt; <sup>`type`</sup>](./4-restrictions.md#1-1-predicate)
2. [RuleFn&lt;T&gt; <sup>`type`</sup>](./4-restrictions.md#1-2-rulefn)
3. [toBe <sup>`fn`</sup>](./4-restrictions.md#1-3-tobe)
4. [notToBe <sup>`fn`</sup>](./4-restrictions.md#1-4-nottobe)
5. [and <sup>`fn`</sup>](./4-restrictions.md#1-5-and)
6. [or <sup>`fn`</sup>](./4-restrictions.md#1-6-or)
7. [not <sup>`fn`</sup>](./4-restrictions.md#1-7-not)

9. [Predicates](./4-restrictions.md#2-predicates)
1. [greaterThen (gt)](./4-restrictions.md#2-1-gt)
Expand Down

0 comments on commit 256ab16

Please sign in to comment.