Skip to content

Commit a4aef13

Browse files
zachbuttonzachbutton
committed
docs: Exclude Opts from documentation (only UserOpts)
1 parent 2938f5e commit a4aef13

File tree

4 files changed

+18
-217
lines changed

4 files changed

+18
-217
lines changed

‎docs/classes/default.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@
3939

4040
#### Parameters
4141

42-
| Name | Type |
43-
| :------ | :---------------------------------------------------------------------------------------------------------------- |
44-
| `_opts` | [`Opts`](../interfaces/Opts.md)<`Crystal`, `Shard`\> \| [`UserOpts`](../modules.md#useropts)<`Crystal`, `Shard`\> |
42+
| Name | Type |
43+
| :------ | :--------------------------------------------------------------------------------------- |
44+
| `_opts` | `Opts`<`Crystal`, `Shard`\> \| [`UserOpts`](../modules.md#useropts)<`Crystal`, `Shard`\> |
4545

4646
#### Defined in
4747

48-
[index.ts:63](https://github.com/zachbutton/crystalize.js/blob/2881530/src/index.ts#L63)
48+
[index.ts:63](https://github.com/zachbutton/crystalize.js/blob/2938f5e/src/index.ts#L63)
4949

5050
## Methods
5151

@@ -65,7 +65,7 @@
6565

6666
#### Defined in
6767

68-
[index.ts:159](https://github.com/zachbutton/crystalize.js/blob/2881530/src/index.ts#L159)
68+
[index.ts:159](https://github.com/zachbutton/crystalize.js/blob/2938f5e/src/index.ts#L159)
6969

7070
---
7171

@@ -85,7 +85,7 @@
8585

8686
#### Defined in
8787

88-
[index.ts:154](https://github.com/zachbutton/crystalize.js/blob/2881530/src/index.ts#L154)
88+
[index.ts:154](https://github.com/zachbutton/crystalize.js/blob/2938f5e/src/index.ts#L154)
8989

9090
---
9191

@@ -105,7 +105,7 @@
105105

106106
#### Defined in
107107

108-
[index.ts:202](https://github.com/zachbutton/crystalize.js/blob/2881530/src/index.ts#L202)
108+
[index.ts:202](https://github.com/zachbutton/crystalize.js/blob/2938f5e/src/index.ts#L202)
109109

110110
---
111111

@@ -125,7 +125,7 @@
125125

126126
#### Defined in
127127

128-
[index.ts:163](https://github.com/zachbutton/crystalize.js/blob/2881530/src/index.ts#L163)
128+
[index.ts:163](https://github.com/zachbutton/crystalize.js/blob/2938f5e/src/index.ts#L163)
129129

130130
---
131131

@@ -145,7 +145,7 @@
145145

146146
#### Defined in
147147

148-
[index.ts:191](https://github.com/zachbutton/crystalize.js/blob/2881530/src/index.ts#L191)
148+
[index.ts:191](https://github.com/zachbutton/crystalize.js/blob/2938f5e/src/index.ts#L191)
149149

150150
---
151151

@@ -188,4 +188,4 @@
188188

189189
#### Defined in
190190

191-
[index.ts:97](https://github.com/zachbutton/crystalize.js/blob/2881530/src/index.ts#L97)
191+
[index.ts:97](https://github.com/zachbutton/crystalize.js/blob/2938f5e/src/index.ts#L97)

‎docs/interfaces/Opts.md

Lines changed: 0 additions & 195 deletions
This file was deleted.

‎docs/modules.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@
88

99
- [default](classes/default.md)
1010

11-
### Interfaces
12-
13-
- [Opts](interfaces/Opts.md)
14-
1511
### Type Aliases
1612

1713
- [CrystalizerReducer](modules.md#crystalizerreducer)
@@ -52,7 +48,7 @@
5248

5349
#### Defined in
5450

55-
[index.ts:19](https://github.com/zachbutton/crystalize.js/blob/2881530/src/index.ts#L19)
51+
[index.ts:19](https://github.com/zachbutton/crystalize.js/blob/2938f5e/src/index.ts#L19)
5652

5753
---
5854

@@ -68,7 +64,7 @@
6864

6965
#### Defined in
7066

71-
[index.ts:10](https://github.com/zachbutton/crystalize.js/blob/2881530/src/index.ts#L10)
67+
[index.ts:10](https://github.com/zachbutton/crystalize.js/blob/2938f5e/src/index.ts#L10)
7268

7369
---
7470

@@ -82,7 +78,7 @@
8278

8379
#### Defined in
8480

85-
[index.ts:4](https://github.com/zachbutton/crystalize.js/blob/2881530/src/index.ts#L4)
81+
[index.ts:4](https://github.com/zachbutton/crystalize.js/blob/2938f5e/src/index.ts#L4)
8682

8783
---
8884

@@ -92,7 +88,7 @@
9288

9389
#### Defined in
9490

95-
[index.ts:3](https://github.com/zachbutton/crystalize.js/blob/2881530/src/index.ts#L3)
91+
[index.ts:3](https://github.com/zachbutton/crystalize.js/blob/2938f5e/src/index.ts#L3)
9692

9793
---
9894

@@ -122,7 +118,7 @@
122118

123119
#### Defined in
124120

125-
[index.ts:8](https://github.com/zachbutton/crystalize.js/blob/2881530/src/index.ts#L8)
121+
[index.ts:8](https://github.com/zachbutton/crystalize.js/blob/2938f5e/src/index.ts#L8)
126122

127123
---
128124

@@ -138,7 +134,7 @@
138134

139135
#### Defined in
140136

141-
[index.ts:24](https://github.com/zachbutton/crystalize.js/blob/2881530/src/index.ts#L24)
137+
[index.ts:24](https://github.com/zachbutton/crystalize.js/blob/2938f5e/src/index.ts#L24)
142138

143139
---
144140

@@ -166,4 +162,4 @@
166162

167163
#### Defined in
168164

169-
[index.ts:26](https://github.com/zachbutton/crystalize.js/blob/2881530/src/index.ts#L26)
165+
[index.ts:26](https://github.com/zachbutton/crystalize.js/blob/2938f5e/src/index.ts#L26)

‎src/index.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ type InternalOpts<Shard> = {
3939
__getTime?: () => number;
4040
};
4141

42-
export interface Opts<Crystal, Shard>
42+
interface Opts<Crystal, Shard>
4343
extends UserOpts<Crystal, Shard>,
4444
InternalOpts<Shard> {}
4545

0 commit comments

Comments
 (0)