Skip to content

Commit b68240e

Browse files
authored
Update docs dependencies (mongodb-university#160)
* Update docs dependencies Also, update broken links throughout. * Rebuild docs with proper types
1 parent d923c41 commit b68240e

41 files changed

Lines changed: 14254 additions & 19886 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/docs/develop/api/classes/Bluehawk.md

Lines changed: 33 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,21 @@ The frontend of Bluehawk.
1212

1313
### constructor
1414

15-
**new Bluehawk**(`configuration?`)
15+
**new Bluehawk**(`configuration?`): [`Bluehawk`](Bluehawk.md)
1616

1717
#### Parameters
1818

1919
| Name | Type |
2020
| :------ | :------ |
2121
| `configuration?` | `BluehawkConfiguration` |
2222

23+
#### Returns
24+
25+
[`Bluehawk`](Bluehawk.md)
26+
2327
#### Defined in
2428

25-
[src/bluehawk/bluehawk.ts:44](https://github.com/mongodben/Bluehawk/blob/be77c09/src/bluehawk/bluehawk.ts#L44)
29+
[bluehawk/bluehawk.ts:43](https://github.com/krollins-mdb/Bluehawk/blob/0886b9526801a2b31a73b01fc05e9bdcbd23c69e/src/bluehawk/bluehawk.ts#L43)
2630

2731
## Properties
2832

@@ -32,7 +36,7 @@ The frontend of Bluehawk.
3236

3337
#### Defined in
3438

35-
[src/bluehawk/bluehawk.ts:227](https://github.com/mongodben/Bluehawk/blob/be77c09/src/bluehawk/bluehawk.ts#L227)
39+
[bluehawk/bluehawk.ts:221](https://github.com/krollins-mdb/Bluehawk/blob/0886b9526801a2b31a73b01fc05e9bdcbd23c69e/src/bluehawk/bluehawk.ts#L221)
3640

3741
___
3842

@@ -42,7 +46,7 @@ ___
4246

4347
#### Defined in
4448

45-
[src/bluehawk/bluehawk.ts:226](https://github.com/mongodben/Bluehawk/blob/be77c09/src/bluehawk/bluehawk.ts#L226)
49+
[bluehawk/bluehawk.ts:220](https://github.com/krollins-mdb/Bluehawk/blob/0886b9526801a2b31a73b01fc05e9bdcbd23c69e/src/bluehawk/bluehawk.ts#L220)
4650

4751
## Accessors
4852

@@ -56,7 +60,7 @@ ___
5660

5761
#### Defined in
5862

59-
[src/bluehawk/bluehawk.ts:222](https://github.com/mongodben/Bluehawk/blob/be77c09/src/bluehawk/bluehawk.ts#L222)
63+
[bluehawk/bluehawk.ts:216](https://github.com/krollins-mdb/Bluehawk/blob/0886b9526801a2b31a73b01fc05e9bdcbd23c69e/src/bluehawk/bluehawk.ts#L216)
6064

6165
## Methods
6266

@@ -71,46 +75,46 @@ Specify the special patterns for a given language.
7175
| Name | Type |
7276
| :------ | :------ |
7377
| `forFileExtension` | `string` \| `string`[] |
74-
| `languageSpecification` | [`LanguageSpecification`](../interfaces/LanguageSpecification) |
78+
| `languageSpecification` | [`LanguageSpecification`](../interfaces/LanguageSpecification.md) |
7579

7680
#### Returns
7781

7882
`void`
7983

8084
#### Defined in
8185

82-
[src/bluehawk/bluehawk.ts:79](https://github.com/mongodben/Bluehawk/blob/be77c09/src/bluehawk/bluehawk.ts#L79)
86+
[bluehawk/bluehawk.ts:78](https://github.com/krollins-mdb/Bluehawk/blob/0886b9526801a2b31a73b01fc05e9bdcbd23c69e/src/bluehawk/bluehawk.ts#L78)
8387

8488
___
8589

8690
### parse
8791

88-
**parse**(`source`, `options?`): [`ParseResult`](../interfaces/ParseResult)
92+
**parse**(`source`, `options?`): [`ParseResult`](../interfaces/ParseResult.md)
8993

9094
Parses the given source file into tags.
9195

9296
#### Parameters
9397

9498
| Name | Type |
9599
| :------ | :------ |
96-
| `source` | [`Document`](Document) |
100+
| `source` | [`Document`](Document.md) |
97101
| `options?` | `Object` |
98-
| `options.languageSpecification?` | [`LanguageSpecification`](../interfaces/LanguageSpecification) |
99-
| `options.reporter?` | `ActionReporter` |
102+
| `options.languageSpecification?` | [`LanguageSpecification`](../interfaces/LanguageSpecification.md) |
103+
| `options.reporter?` | [`ActionReporter`](../interfaces/ActionReporter.md) |
100104

101105
#### Returns
102106

103-
[`ParseResult`](../interfaces/ParseResult)
107+
[`ParseResult`](../interfaces/ParseResult.md)
104108

105109
#### Defined in
106110

107-
[src/bluehawk/bluehawk.ts:162](https://github.com/mongodben/Bluehawk/blob/be77c09/src/bluehawk/bluehawk.ts#L162)
111+
[bluehawk/bluehawk.ts:161](https://github.com/krollins-mdb/Bluehawk/blob/0886b9526801a2b31a73b01fc05e9bdcbd23c69e/src/bluehawk/bluehawk.ts#L161)
108112

109113
___
110114

111115
### parseAndProcess
112116

113-
**parseAndProcess**(`path`, `optionsIn?`): `Promise`<`void`\>
117+
**parseAndProcess**(`path`, `optionsIn?`): `Promise`\<`void`\>
114118

115119
Runs through all given source paths to parse and process them.
116120

@@ -123,35 +127,35 @@ Runs through all given source paths to parse and process them.
123127

124128
#### Returns
125129

126-
`Promise`<`void`\>
130+
`Promise`\<`void`\>
127131

128132
#### Defined in
129133

130-
[src/bluehawk/bluehawk.ts:92](https://github.com/mongodben/Bluehawk/blob/be77c09/src/bluehawk/bluehawk.ts#L92)
134+
[bluehawk/bluehawk.ts:91](https://github.com/krollins-mdb/Bluehawk/blob/0886b9526801a2b31a73b01fc05e9bdcbd23c69e/src/bluehawk/bluehawk.ts#L91)
131135

132136
___
133137

134138
### process
135139

136-
**process**(`parseResult`, `processOptions?`): `Promise`<`BluehawkFiles`\>
140+
**process**(`parseResult`, `processOptions?`): `Promise`\<`BluehawkFiles`\>
137141

138-
Executes the tags on the given source. Use [Bluehawk.subscribe](Bluehawk#subscribe) to get
142+
Executes the tags on the given source. Use [[Bluehawk.subscribe]] to get
139143
results.
140144

141145
#### Parameters
142146

143147
| Name | Type |
144148
| :------ | :------ |
145-
| `parseResult` | [`ParseResult`](../interfaces/ParseResult) |
146-
| `processOptions?` | [`ProcessOptions`](../interfaces/ProcessOptions) |
149+
| `parseResult` | [`ParseResult`](../interfaces/ParseResult.md) |
150+
| `processOptions?` | [`ProcessOptions`](../interfaces/ProcessOptions.md) |
147151

148152
#### Returns
149153

150-
`Promise`<`BluehawkFiles`\>
154+
`Promise`\<`BluehawkFiles`\>
151155

152156
#### Defined in
153157

154-
[src/bluehawk/bluehawk.ts:215](https://github.com/mongodben/Bluehawk/blob/be77c09/src/bluehawk/bluehawk.ts#L215)
158+
[bluehawk/bluehawk.ts:209](https://github.com/krollins-mdb/Bluehawk/blob/0886b9526801a2b31a73b01fc05e9bdcbd23c69e/src/bluehawk/bluehawk.ts#L209)
155159

156160
___
157161

@@ -166,7 +170,7 @@ support for the tag under the given name.
166170

167171
| Name | Type |
168172
| :------ | :------ |
169-
| `tag` | [`AnyTag`](../interfaces/AnyTag) |
173+
| `tag` | [`AnyTag`](../interfaces/AnyTag.md) |
170174
| `alternateName?` | `string` |
171175

172176
#### Returns
@@ -175,7 +179,7 @@ support for the tag under the given name.
175179

176180
#### Defined in
177181

178-
[src/bluehawk/bluehawk.ts:72](https://github.com/mongodben/Bluehawk/blob/be77c09/src/bluehawk/bluehawk.ts#L72)
182+
[bluehawk/bluehawk.ts:71](https://github.com/krollins-mdb/Bluehawk/blob/0886b9526801a2b31a73b01fc05e9bdcbd23c69e/src/bluehawk/bluehawk.ts#L71)
179183

180184
___
181185

@@ -189,26 +193,26 @@ Subscribe to processed documents as they are processed by Bluehawk.
189193

190194
| Name | Type |
191195
| :------ | :------ |
192-
| `listener` | [`Listener`](../modules#listener) \| [`Listener`](../modules#listener)[] |
196+
| `listener` | [`Listener`](../modules.md#listener) \| [`Listener`](../modules.md#listener)[] |
193197

194198
#### Returns
195199

196200
`void`
197201

198202
#### Defined in
199203

200-
[src/bluehawk/bluehawk.ts:203](https://github.com/mongodben/Bluehawk/blob/be77c09/src/bluehawk/bluehawk.ts#L203)
204+
[bluehawk/bluehawk.ts:197](https://github.com/krollins-mdb/Bluehawk/blob/0886b9526801a2b31a73b01fc05e9bdcbd23c69e/src/bluehawk/bluehawk.ts#L197)
201205

202206
___
203207

204208
### waitForListeners
205209

206-
**waitForListeners**(): `Promise`<`void`\>
210+
**waitForListeners**(): `Promise`\<`void`\>
207211

208212
#### Returns
209213

210-
`Promise`<`void`\>
214+
`Promise`\<`void`\>
211215

212216
#### Defined in
213217

214-
[src/bluehawk/bluehawk.ts:155](https://github.com/mongodben/Bluehawk/blob/be77c09/src/bluehawk/bluehawk.ts#L155)
218+
[bluehawk/bluehawk.ts:154](https://github.com/krollins-mdb/Bluehawk/blob/0886b9526801a2b31a73b01fc05e9bdcbd23c69e/src/bluehawk/bluehawk.ts#L154)

0 commit comments

Comments
 (0)