jsdoc

docs-ts.json

@@ -0,0 +1,3 @@
+{
+  "exclude": ["src/types/**/*", "src/util/**/*", "src/index.ts"]
+}

docs/_config.yml

@@ -0,0 +1,9 @@
+remote_theme: pmarsceill/just-the-docs
+
+# Enable or disable the site search
+search_enabled: true
+
+# Aux links for the upper right navigation
+aux_links:
+  'spectacles-ts on GitHub':
+    - 'https://github.com/anthonyjoeseph/spectacles-ts'

docs/index.md

@@ -0,0 +1,4 @@
+---
+title: Home
+nav_order: 1
+---

docs/modules/index.md

@@ -0,0 +1,6 @@
+---
+title: Modules
+has_children: true
+permalink: /docs/modules
+nav_order: 2
+---

docs/modules/values/get.ts.md

@@ -0,0 +1,42 @@
+---
+title: values/get.ts
+nav_order: 1
+parent: Modules
+---
+
+## get overview
+
+Added in v1.0.7
+
+---
+
+<h2 class="text-delta">Table of contents</h2>
+
+- [utils](#utils)
+  - [get](#get)
+
+---
+
+# utils
+
+## get
+
+`get` monocle-ts Optional equivalent
+
+**Signature**
+
+```ts
+export declare const get: Get
+```
+
+**Example**
+
+```ts
+import { pipe } from 'fp-ts/function'
+import { get } from 'spectacles-ts'
+
+const gotten = pipe({ a: { b: ['abc', 'def'] } }, get('a.b.[number]', 0))
+console.log(gotten)
+```
+
+Added in v1.0.7

docs/modules/values/modify.ts.md

@@ -0,0 +1,38 @@
+---
+title: values/modify.ts
+nav_order: 2
+parent: Modules
+---
+
+## modify overview
+
+Added in v1.0.7
+
+---
+
+<h2 class="text-delta">Table of contents</h2>
+
+- [utils](#utils)
+  - [modify](#modify)
+
+---
+
+# utils
+
+## modify
+
+`modify` monocle-ts Lens.modify equivalent
+
+**Signature**
+
+```ts
+export declare const modify: Modify
+```
+
+**Example**
+
+```ts
+// TODO;
+```
+
+Added in v1.0.7

docs/modules/values/modifyF.ts.md

@@ -0,0 +1,38 @@
+---
+title: values/modifyF.ts
+nav_order: 3
+parent: Modules
+---
+
+## modifyF overview
+
+Added in v1.0.7
+
+---
+
+<h2 class="text-delta">Table of contents</h2>
+
+- [utils](#utils)
+  - [modifyF](#modifyf)
+
+---
+
+# utils
+
+## modifyF
+
+`modifyF`
+
+**Signature**
+
+```ts
+export declare const modifyF: ModifyF
+```
+
+**Example**
+
+```ts
+// TODO;
+```
+
+Added in v1.0.7

docs/modules/values/modifyOption.ts.md

@@ -0,0 +1,38 @@
+---
+title: values/modifyOption.ts
+nav_order: 4
+parent: Modules
+---
+
+## modifyOption overview
+
+Added in v1.0.7
+
+---
+
+<h2 class="text-delta">Table of contents</h2>
+
+- [utils](#utils)
+  - [modifyOption](#modifyoption)
+
+---
+
+# utils
+
+## modifyOption
+
+`modifyOption`
+
+**Signature**
+
+```ts
+export declare const modifyOption: ModifyOption
+```
+
+**Example**
+
+```ts
+// TODO;
+```
+
+Added in v1.0.7

docs/modules/values/modifyOptionW.ts.md

@@ -0,0 +1,38 @@
+---
+title: values/modifyOptionW.ts
+nav_order: 5
+parent: Modules
+---
+
+## modifyOptionW overview
+
+Added in v1.0.7
+
+---
+
+<h2 class="text-delta">Table of contents</h2>
+
+- [utils](#utils)
+  - [modifyOptionW](#modifyoptionw)
+
+---
+
+# utils
+
+## modifyOptionW
+
+`modifyOptionW`
+
+**Signature**
+
+```ts
+export declare const modifyOptionW: ModifyOptionW
+```
+
+**Example**
+
+```ts
+// TODO;
+```
+
+Added in v1.0.7

docs/modules/values/modifyW.ts.md

@@ -0,0 +1,38 @@
+---
+title: values/modifyW.ts
+nav_order: 6
+parent: Modules
+---
+
+## modifyW overview
+
+Added in v1.0.7
+
+---
+
+<h2 class="text-delta">Table of contents</h2>
+
+- [utils](#utils)
+  - [modifyW](#modifyw)
+
+---
+
+# utils
+
+## modifyW
+
+`modifyW`
+
+**Signature**
+
+```ts
+export declare const modifyW: ModifyW
+```
+
+**Example**
+
+```ts
+// TODO;
+```
+
+Added in v1.0.7

docs/modules/values/remove.ts.md

@@ -0,0 +1,38 @@
+---
+title: values/remove.ts
+nav_order: 7
+parent: Modules
+---
+
+## remove overview
+
+Added in v1.0.7
+
+---
+
+<h2 class="text-delta">Table of contents</h2>
+
+- [utils](#utils)
+  - [remove](#remove)
+
+---
+
+# utils
+
+## remove
+
+`remove`
+
+**Signature**
+
+```ts
+export declare const remove: Remove
+```
+
+**Example**
+
+```ts
+// TODO;
+```
+
+Added in v1.0.7

docs/modules/values/rename.ts.md

@@ -0,0 +1,38 @@
+---
+title: values/rename.ts
+nav_order: 8
+parent: Modules
+---
+
+## rename overview
+
+Added in v1.0.7
+
+---
+
+<h2 class="text-delta">Table of contents</h2>
+
+- [utils](#utils)
+  - [rename](#rename)
+
+---
+
+# utils
+
+## rename
+
+`rename`
+
+**Signature**
+
+```ts
+export declare const rename: Rename
+```
+
+**Example**
+
+```ts
+// TODO;
+```
+
+Added in v1.0.7

docs/modules/values/set.ts.md

@@ -0,0 +1,38 @@
+---
+title: values/set.ts
+nav_order: 9
+parent: Modules
+---
+
+## set overview
+
+Added in v1.0.7
+
+---
+
+<h2 class="text-delta">Table of contents</h2>
+
+- [utils](#utils)
+  - [set](#set)
+
+---
+
+# utils
+
+## set
+
+`set`
+
+**Signature**
+
+```ts
+export declare const set: Set
+```
+
+**Example**
+
+```ts
+// TODO;
+```
+
+Added in v1.0.7