Skip to content

Commit 6975ac4

Browse files
committed
docs: rebuild documentation
1 parent dca16a7 commit 6975ac4

File tree

153 files changed

+919
-451
lines changed

Some content is hidden

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

153 files changed

+919
-451
lines changed

docs/api/src/exports/classes/CliError.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Class: CliError
88

9-
Defined in: [src/error.ts:156](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L156)
9+
Defined in: [src/error.ts:156](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/error.ts#L156)
1010

1111
Represents a CLI-specific error with suggested exit code and other
1212
properties. As `CliError` has built-in support for cause chaining, this class
@@ -31,9 +31,9 @@ can be used as a simple wrapper around other errors.
3131

3232
### new CliError()
3333

34-
> **new CliError**(`reason`?, `options`?): [`CliError`](CliError.md)
34+
> **new CliError**(`reason`?, `options`?): `CliError`
3535
36-
Defined in: [src/error.ts:169](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L169)
36+
Defined in: [src/error.ts:169](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/error.ts#L169)
3737

3838
Represents a CLI-specific error, optionally with suggested exit code and
3939
other context.
@@ -50,17 +50,17 @@ other context.
5050

5151
#### Returns
5252

53-
[`CliError`](CliError.md)
53+
`CliError`
5454

5555
#### Overrides
5656

5757
`AppError.constructor`
5858

5959
### new CliError()
6060

61-
> **new CliError**(`reason`, `options`, `message`, `superOptions`): [`CliError`](CliError.md)
61+
> **new CliError**(`reason`, `options`, `message`, `superOptions`): `CliError`
6262
63-
Defined in: [src/error.ts:174](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L174)
63+
Defined in: [src/error.ts:174](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/error.ts#L174)
6464

6565
This constructor syntax is used by subclasses when calling this constructor
6666
via `super`.
@@ -85,7 +85,7 @@ via `super`.
8585

8686
#### Returns
8787

88-
[`CliError`](CliError.md)
88+
`CliError`
8989

9090
#### Overrides
9191

@@ -97,7 +97,7 @@ via `super`.
9797

9898
> **\[$type\]**: `string`[]
9999
100-
Defined in: [src/error.ts:164](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L164)
100+
Defined in: [src/error.ts:164](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/error.ts#L164)
101101

102102
***
103103

@@ -121,7 +121,7 @@ Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26
121121

122122
> **dangerouslyFatal**: `boolean` = `false`
123123
124-
Defined in: [src/error.ts:162](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L162)
124+
Defined in: [src/error.ts:162](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/error.ts#L162)
125125

126126
This option is similar in intent to Yargs's `exitProcess()` function,
127127
except applied more granularly.
@@ -184,9 +184,9 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076
184184

185185
### showHelp
186186

187-
> **showHelp**: `NonNullable`\<`undefined` \| `false` \| `"full"` \| `"short"` \| `"default"`\>
187+
> **showHelp**: `NonNullable`\<`undefined` \| `false` \| `"short"` \| `"full"` \| `"default"`\>
188188
189-
Defined in: [src/error.ts:161](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L161)
189+
Defined in: [src/error.ts:161](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/error.ts#L161)
190190

191191
If `showHelp` is set to a string that isn't `"default"`, help text will be
192192
sent to stderr. Note that help text is always sent _before this exception
@@ -237,7 +237,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078
237237

238238
> **suggestedExitCode**: [`FrameworkExitCode`](../enumerations/FrameworkExitCode.md) = `FrameworkExitCode.DefaultError`
239239
240-
Defined in: [src/error.ts:160](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L160)
240+
Defined in: [src/error.ts:160](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/error.ts#L160)
241241

242242
The exit code that will be returned when the application exits, given
243243
nothing else goes wrong in the interim.

docs/api/src/exports/classes/GracefulEarlyExitError.md

+12-12
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Class: GracefulEarlyExitError
88

9-
Defined in: [src/error.ts:246](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L246)
9+
Defined in: [src/error.ts:246](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/error.ts#L246)
1010

1111
Represents an exceptional event that should result in the immediate
1212
termination of the application but with an exit code indicating success
@@ -23,9 +23,9 @@ ignored.
2323

2424
### new GracefulEarlyExitError()
2525

26-
> **new GracefulEarlyExitError**(`error`?, `options`?): [`GracefulEarlyExitError`](GracefulEarlyExitError.md)
26+
> **new GracefulEarlyExitError**(`error`?, `options`?): `GracefulEarlyExitError`
2727
28-
Defined in: [src/error.ts:257](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L257)
28+
Defined in: [src/error.ts:257](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/error.ts#L257)
2929

3030
Represents an exceptional event that should result in the immediate
3131
termination of the application but with an exit code indicating success
@@ -46,23 +46,23 @@ ignored.
4646

4747
#### Returns
4848

49-
[`GracefulEarlyExitError`](GracefulEarlyExitError.md)
49+
`GracefulEarlyExitError`
5050

5151
#### Overrides
5252

53-
[`CliError`](CliError.md).[`constructor`](CliError.md#constructors)
53+
[`CliError`](CliError.md).[`constructor`](CliError.md#constructor)
5454

5555
## Properties
5656

5757
### \[$type\]
5858

5959
> **\[$type\]**: `string`[]
6060
61-
Defined in: [src/error.ts:248](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L248)
61+
Defined in: [src/error.ts:248](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/error.ts#L248)
6262

6363
#### Overrides
6464

65-
[`CliError`](CliError.md).[`[$type]`](CliError.md#$type)
65+
[`CliError`](CliError.md).[`[$type]`](CliError.md#type)
6666

6767
***
6868

@@ -82,7 +82,7 @@ Defined in: node\_modules/typescript/lib/lib.es2022.error.d.ts:26
8282

8383
> **dangerouslyFatal**: `boolean` = `false`
8484
85-
Defined in: [src/error.ts:162](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L162)
85+
Defined in: [src/error.ts:162](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/error.ts#L162)
8686

8787
This option is similar in intent to Yargs's `exitProcess()` function,
8888
except applied more granularly.
@@ -127,7 +127,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1077
127127

128128
#### Inherited from
129129

130-
[`CliError`](CliError.md).[`message`](CliError.md#message-1)
130+
[`CliError`](CliError.md).[`message`](CliError.md#message)
131131

132132
***
133133

@@ -145,9 +145,9 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1076
145145

146146
### showHelp
147147

148-
> **showHelp**: `NonNullable`\<`undefined` \| `false` \| `"full"` \| `"short"` \| `"default"`\>
148+
> **showHelp**: `NonNullable`\<`undefined` \| `false` \| `"short"` \| `"full"` \| `"default"`\>
149149
150-
Defined in: [src/error.ts:161](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L161)
150+
Defined in: [src/error.ts:161](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/error.ts#L161)
151151

152152
If `showHelp` is set to a string that isn't `"default"`, help text will be
153153
sent to stderr. Note that help text is always sent _before this exception
@@ -198,7 +198,7 @@ Defined in: node\_modules/typescript/lib/lib.es5.d.ts:1078
198198

199199
> **suggestedExitCode**: [`FrameworkExitCode`](../enumerations/FrameworkExitCode.md) = `FrameworkExitCode.DefaultError`
200200
201-
Defined in: [src/error.ts:160](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L160)
201+
Defined in: [src/error.ts:160](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/error.ts#L160)
202202

203203
The exit code that will be returned when the application exits, given
204204
nothing else goes wrong in the interim.

docs/api/src/exports/enumerations/FrameworkExitCode.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
# Enumeration: FrameworkExitCode
88

9-
Defined in: [src/constant.ts:51](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/constant.ts#L51)
9+
Defined in: [src/constant.ts:51](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/constant.ts#L51)
1010

1111
Well-known exit codes shared across CLI implementations.
1212

@@ -16,7 +16,7 @@ Well-known exit codes shared across CLI implementations.
1616

1717
> **AssertionFailed**: `3`
1818
19-
Defined in: [src/constant.ts:75](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/constant.ts#L75)
19+
Defined in: [src/constant.ts:75](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/constant.ts#L75)
2020

2121
The exit code used when a sanity check fails. This includes (but is not
2222
limited to) all _framework errors_.
@@ -34,7 +34,7 @@ of Black Flag by the developer.
3434

3535
> **DefaultError**: `1`
3636
37-
Defined in: [src/constant.ts:59](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/constant.ts#L59)
37+
Defined in: [src/constant.ts:59](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/constant.ts#L59)
3838

3939
Hard-coded default fallback exit code when fatal errors occur.
4040

@@ -44,7 +44,7 @@ Hard-coded default fallback exit code when fatal errors occur.
4444

4545
> **NotImplemented**: `2`
4646
47-
Defined in: [src/constant.ts:63](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/constant.ts#L63)
47+
Defined in: [src/constant.ts:63](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/constant.ts#L63)
4848

4949
The exit code used when executing an unimplemented child command.
5050

@@ -54,6 +54,6 @@ The exit code used when executing an unimplemented child command.
5454

5555
> **Ok**: `0`
5656
57-
Defined in: [src/constant.ts:55](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/constant.ts#L55)
57+
Defined in: [src/constant.ts:55](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/constant.ts#L55)
5858

5959
The exit code used when execution succeeds and exits gracefully.

docs/api/src/exports/functions/configureProgram.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **configureProgram**(`commandModulesPath`, `configurationHooks`?): `Promise`\<[`PreExecutionContext`](../util/type-aliases/PreExecutionContext.md)\>
1010
11-
Defined in: [src/index.ts:188](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/index.ts#L188)
11+
Defined in: [src/index.ts:188](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/index.ts#L188)
1212

1313
Create and return a [PreExecutionContext](../util/type-aliases/PreExecutionContext.md) containing fully-configured
1414
[Program](../util/type-aliases/Program.md) instances and an [Executor](../util/type-aliases/Executor.md) entry point function.

docs/api/src/exports/functions/isCliError.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **isCliError**(`parameter`): `parameter is CliError`
1010
11-
Defined in: [src/error.ts:33](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L33)
11+
Defined in: [src/error.ts:33](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/error.ts#L33)
1212

1313
Type guard for [CliError](../classes/CliError.md).
1414

docs/api/src/exports/functions/isGracefulEarlyExitError.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
> **isGracefulEarlyExitError**(`parameter`): `parameter is GracefulEarlyExitError`
1010
11-
Defined in: [src/error.ts:46](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/error.ts#L46)
11+
Defined in: [src/error.ts:46](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/error.ts#L46)
1212

1313
Type guard for [GracefulEarlyExitError](../classes/GracefulEarlyExitError.md).
1414

docs/api/src/exports/functions/runProgram.md

+28-14
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
1212
13-
Defined in: [src/index.ts:674](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/index.ts#L674)
13+
Defined in: [src/index.ts:674](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/index.ts#L674)
1414

1515
Invokes the dynamically imported
1616
`configureProgram(commandModulesPath).execute()` function.
@@ -27,7 +27,9 @@ desired.
2727

2828
### Type Parameters
2929

30-
**CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\>
30+
#### CustomCliArguments
31+
32+
`CustomCliArguments` *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\>
3133

3234
### Parameters
3335

@@ -46,7 +48,7 @@ if any other exception occurs, or `Arguments` otherwise.
4648

4749
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `configurationHooks`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
4850
49-
Defined in: [src/index.ts:694](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/index.ts#L694)
51+
Defined in: [src/index.ts:694](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/index.ts#L694)
5052

5153
Invokes the dynamically imported `configureProgram(commandModulesPath,
5254
configurationHooks).execute()` function.
@@ -63,7 +65,9 @@ desired.
6365

6466
### Type Parameters
6567

66-
**CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\>
68+
#### CustomCliArguments
69+
70+
`CustomCliArguments` *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\>
6771

6872
### Parameters
6973

@@ -86,7 +90,7 @@ if any other exception occurs, or `Arguments` otherwise.
8690

8791
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `preExecutionContext`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
8892
89-
Defined in: [src/index.ts:718](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/index.ts#L718)
93+
Defined in: [src/index.ts:718](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/index.ts#L718)
9094

9195
Invokes the `preExecutionContext.execute()` function.
9296

@@ -104,7 +108,9 @@ is returned.
104108

105109
### Type Parameters
106110

107-
**CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\>
111+
#### CustomCliArguments
112+
113+
`CustomCliArguments` *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\>
108114

109115
### Parameters
110116

@@ -127,7 +133,7 @@ if any other exception occurs, or `Arguments` otherwise.
127133

128134
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `argv`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
129135
130-
Defined in: [src/index.ts:742](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/index.ts#L742)
136+
Defined in: [src/index.ts:742](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/index.ts#L742)
131137

132138
Invokes the dynamically imported
133139
`configureProgram(commandModulesPath).execute(argv)` function. If `argv` is a
@@ -145,7 +151,9 @@ desired.
145151

146152
### Type Parameters
147153

148-
**CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\>
154+
#### CustomCliArguments
155+
156+
`CustomCliArguments` *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\>
149157

150158
### Parameters
151159

@@ -168,7 +176,7 @@ if any other exception occurs, or `Arguments` otherwise.
168176

169177
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `argv`, `configurationHooks`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
170178
171-
Defined in: [src/index.ts:766](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/index.ts#L766)
179+
Defined in: [src/index.ts:766](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/index.ts#L766)
172180

173181
Invokes the dynamically imported `configureProgram(commandModulesPath,
174182
configurationHooks).execute(argv)` function. If `argv` is a string, `argv =
@@ -186,7 +194,9 @@ desired.
186194

187195
### Type Parameters
188196

189-
**CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\>
197+
#### CustomCliArguments
198+
199+
`CustomCliArguments` *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\>
190200

191201
### Parameters
192202

@@ -213,7 +223,7 @@ if any other exception occurs, or `Arguments` otherwise.
213223

214224
> **runProgram**\<`CustomCliArguments`\>(`commandModulesPath`, `argv`, `preExecutionContext`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
215225
216-
Defined in: [src/index.ts:792](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/index.ts#L792)
226+
Defined in: [src/index.ts:792](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/index.ts#L792)
217227

218228
Invokes the `preExecutionContext.execute(argv)` function. If `argv` is a
219229
string, `argv = argv.split(' ')` is applied first.
@@ -232,7 +242,9 @@ is returned.
232242

233243
### Type Parameters
234244

235-
**CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\>
245+
#### CustomCliArguments
246+
247+
`CustomCliArguments` *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\>
236248

237249
### Parameters
238250

@@ -259,7 +271,7 @@ if any other exception occurs, or `Arguments` otherwise.
259271

260272
> **runProgram**\<`CustomCliArguments`\>(...`args`): [`RunProgramReturnType`](../type-aliases/RunProgramReturnType.md)\<`CustomCliArguments`\>
261273
262-
Defined in: [src/index.ts:812](https://github.com/Xunnamius/black-flag/blob/aaa1a74457790f285cb2c85d4d6a7ee05978fc42/src/index.ts#L812)
274+
Defined in: [src/index.ts:812](https://github.com/Xunnamius/black-flag/blob/dca16a7cbf43b7d8428fc9b34cc49fc69b7b6672/src/index.ts#L812)
263275

264276
Run the given program with the configuration given in `args`.
265277

@@ -272,7 +284,9 @@ is returned.
272284

273285
### Type Parameters
274286

275-
**CustomCliArguments** *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\>
287+
#### CustomCliArguments
288+
289+
`CustomCliArguments` *extends* `Record`\<`string`, `unknown`\> = `Record`\<`string`, `unknown`\>
276290

277291
### Parameters
278292

0 commit comments

Comments
 (0)