fix: update docs

dankreiger · Oct 1, 2021 · 47d1f04 · 47d1f04
1 parent 6402490
commit 47d1f04
Show file tree

Hide file tree

Showing 7 changed files with 66 additions and 2 deletions.
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -7,5 +7,5 @@ if [ "$CURRENT_BRANCH" = "main" ]; then
   exit 1
 fi
 npm run build
-npm run docs
+npm run docs &&
 npx lint-staged
diff --git a/docs/modules/Either/dev/inspect.ts.md b/docs/modules/Either/dev/inspect.ts.md
@@ -12,4 +12,19 @@ Added in v1.0.6
 
 <h2 class="text-delta">Table of contents</h2>
 
+- [utils](#utils)
+  - [inspect](#inspect)
+
 ---
+
+# utils
+
+## inspect
+
+**Signature**
+
+```ts
+export declare function inspect(E: I_Either): T_EitherInspect
+```
+
+Added in v1.0.5
diff --git a/docs/modules/Either/dev/overloads/_ins.ts.md b/docs/modules/Either/dev/overloads/_ins.ts.md
@@ -12,4 +12,19 @@ Added in v1.0.6
 
 <h2 class="text-delta">Table of contents</h2>
 
+- [utils](#utils)
+  - [\_ins](#_ins)
+
 ---
+
+# utils
+
+## \_ins
+
+**Signature**
+
+```ts
+export declare function _ins<T extends 'Left' | 'Right', U>(Type: T, x: U): T_InspectVal<T>
+```
+
+Added in v1.0.6
diff --git a/docs/modules/Either/dev/types/T_EitherInspect.types.ts.md b/docs/modules/Either/dev/types/T_EitherInspect.types.ts.md
@@ -12,4 +12,22 @@ Added in v1.0.6
 
 <h2 class="text-delta">Table of contents</h2>
 
+- [utils](#utils)
+  - [T_EitherInspect (type alias)](#t_eitherinspect-type-alias)
+
 ---
+
+# utils
+
+## T_EitherInspect (type alias)
+
+**Signature**
+
+```ts
+export type T_EitherInspect = I_Either & {
+  Left: <T>(x: T) => I_Left<T> & { inspect: () => T_InspectVal<'Left'> }
+  Right: <T>(x: T) => I_Right<T> & { inspect: () => T_InspectVal<'Right'> }
+}
+```
+
+Added in v1.0.6
diff --git a/docs/modules/Either/dev/types/T_InspectVal.types.ts.md b/docs/modules/Either/dev/types/T_InspectVal.types.ts.md
@@ -12,4 +12,19 @@ Added in v1.0.6
 
 <h2 class="text-delta">Table of contents</h2>
 
+- [utils](#utils)
+  - [T_InspectVal (type alias)](#t_inspectval-type-alias)
+
 ---
+
+# utils
+
+## T_InspectVal (type alias)
+
+**Signature**
+
+```ts
+export type T_InspectVal<T extends 'Left' | 'Right'> = `${T}(${string})`
+```
+
+Added in v1.0.6
diff --git a/docs/modules/Either/interfaces/I_Either.interfaces.ts.md b/docs/modules/Either/interfaces/I_Either.interfaces.ts.md
@@ -29,6 +29,7 @@ export interface I_Either {
   Right: typeof Right
   fromNullable: typeof fromNullable
   tryCatch: typeof tryCatch
+  of: typeof Right
 }
 ```
 

diff --git a/package.json b/package.json
@@ -84,4 +84,4 @@
     "access": "public",
     "registry": "https://registry.npmjs.org"
   }
-}
+}