Skip to content

Commit

Permalink
Update docs [skip actions]
Browse files Browse the repository at this point in the history
  • Loading branch information
Bot committed Sep 30, 2023
1 parent 9306f5b commit 50761cf
Show file tree
Hide file tree
Showing 21 changed files with 291 additions and 291 deletions.
56 changes: 28 additions & 28 deletions packages/args/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Parsed arguments.

#### Defined in

[args/src/Arguments.ts:10](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/Arguments.ts#L10)
[args/src/Arguments.ts:10](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/Arguments.ts#L10)

---

Expand All @@ -86,7 +86,7 @@ Parsed command.

#### Defined in

[args/src/ArgumentsCommand.ts:4](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/ArgumentsCommand.ts#L4)
[args/src/ArgumentsCommand.ts:4](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/ArgumentsCommand.ts#L4)

---

Expand All @@ -106,7 +106,7 @@ Parsed options.

#### Defined in

[args/src/ArgumentsOptions.ts:85](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/ArgumentsOptions.ts#L85)
[args/src/ArgumentsOptions.ts:85](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/ArgumentsOptions.ts#L85)

---

Expand All @@ -128,7 +128,7 @@ Parsed parameters.

#### Defined in

[args/src/ArgumentsParameters.ts:150](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/ArgumentsParameters.ts#L150)
[args/src/ArgumentsParameters.ts:150](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/ArgumentsParameters.ts#L150)

---

Expand All @@ -147,7 +147,7 @@ Unknown options. Unknown options are always parsed as strings.

#### Defined in

[args/src/ArgumentsUnknownOptions.ts:4](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/ArgumentsUnknownOptions.ts#L4)
[args/src/ArgumentsUnknownOptions.ts:4](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/ArgumentsUnknownOptions.ts#L4)

---

Expand All @@ -159,7 +159,7 @@ Unparsed arguments.

#### Defined in

[args/src/Argv.ts:2](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/Argv.ts#L2)
[args/src/Argv.ts:2](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/Argv.ts#L2)

---

Expand All @@ -178,7 +178,7 @@ Unparsed arguments.

#### Defined in

[args/src/OptionConfig.ts:5](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/OptionConfig.ts#L5)
[args/src/OptionConfig.ts:5](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/OptionConfig.ts#L5)

---

Expand All @@ -193,7 +193,7 @@ Unparsed arguments.

#### Defined in

[args/src/ParameterConfig.ts:3](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/ParameterConfig.ts#L3)
[args/src/ParameterConfig.ts:3](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/ParameterConfig.ts#L3)

---

Expand All @@ -212,7 +212,7 @@ Unparsed arguments.

#### Defined in

[args/src/OptionConfig.ts:40](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/OptionConfig.ts#L40)
[args/src/OptionConfig.ts:40](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/OptionConfig.ts#L40)

---

Expand All @@ -224,7 +224,7 @@ Parser's command configuration.

#### Defined in

[args/src/CommandConfig.ts:2](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/CommandConfig.ts#L2)
[args/src/CommandConfig.ts:2](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/CommandConfig.ts#L2)

---

Expand All @@ -236,7 +236,7 @@ Parser's commands configuration.

#### Defined in

[args/src/CommandsConfig.ts:4](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/CommandsConfig.ts#L4)
[args/src/CommandsConfig.ts:4](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/CommandsConfig.ts#L4)

---

Expand All @@ -255,7 +255,7 @@ Parser's commands configuration.

#### Defined in

[args/src/OptionConfig.ts:157](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/OptionConfig.ts#L157)
[args/src/OptionConfig.ts:157](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/OptionConfig.ts#L157)

---

Expand All @@ -267,7 +267,7 @@ Long option name.

#### Defined in

[args/src/LongOptionName.ts:2](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/LongOptionName.ts#L2)
[args/src/LongOptionName.ts:2](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/LongOptionName.ts#L2)

---

Expand All @@ -286,7 +286,7 @@ Long option name.

#### Defined in

[args/src/OptionConfig.ts:78](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/OptionConfig.ts#L78)
[args/src/OptionConfig.ts:78](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/OptionConfig.ts#L78)

---

Expand All @@ -302,7 +302,7 @@ Long option name.

#### Defined in

[args/src/ParameterConfig.ts:32](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/ParameterConfig.ts#L32)
[args/src/ParameterConfig.ts:32](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/ParameterConfig.ts#L32)

---

Expand All @@ -322,7 +322,7 @@ readonly `number`[] ; `count?`: `false` ; `defaultValue`: readonly `number`[] ;

#### Defined in

[args/src/OptionConfig.ts:116](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/OptionConfig.ts#L116)
[args/src/OptionConfig.ts:116](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/OptionConfig.ts#L116)

---

Expand All @@ -340,7 +340,7 @@ Parser's option configuration.

#### Defined in

[args/src/OptionConfig.ts:272](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/OptionConfig.ts#L272)
[args/src/OptionConfig.ts:272](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/OptionConfig.ts#L272)

---

Expand All @@ -352,7 +352,7 @@ Parser's options configuration.

#### Defined in

[args/src/OptionsConfig.ts:4](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/OptionsConfig.ts#L4)
[args/src/OptionsConfig.ts:4](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/OptionsConfig.ts#L4)

---

Expand All @@ -366,7 +366,7 @@ Parser's parameter configuration.

#### Defined in

[args/src/ParameterConfig.ts:97](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/ParameterConfig.ts#L97)
[args/src/ParameterConfig.ts:97](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/ParameterConfig.ts#L97)

---

Expand All @@ -391,7 +391,7 @@ Parser's parameters configuration.

#### Defined in

[args/src/ParametersConfig.ts:4](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/ParametersConfig.ts#L4)
[args/src/ParametersConfig.ts:4](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/ParametersConfig.ts#L4)

---

Expand All @@ -413,7 +413,7 @@ Parser configuration specifies how the command line arguments should be parsed.

#### Defined in

[args/src/ParserConfig.ts:6](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/ParserConfig.ts#L6)
[args/src/ParserConfig.ts:6](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/ParserConfig.ts#L6)

---

Expand All @@ -429,7 +429,7 @@ Short option name.

#### Defined in

[args/src/ShortOptionName.ts:2](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/ShortOptionName.ts#L2)
[args/src/ShortOptionName.ts:2](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/ShortOptionName.ts#L2)

---

Expand All @@ -448,7 +448,7 @@ Short option name.

#### Defined in

[args/src/OptionConfig.ts:192](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/OptionConfig.ts#L192)
[args/src/OptionConfig.ts:192](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/OptionConfig.ts#L192)

---

Expand All @@ -464,7 +464,7 @@ Short option name.

#### Defined in

[args/src/ParameterConfig.ts:64](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/ParameterConfig.ts#L64)
[args/src/ParameterConfig.ts:64](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/ParameterConfig.ts#L64)

---

Expand All @@ -484,7 +484,7 @@ readonly `string`[] ; `count?`: `false` ; `defaultValue`: readonly `string`[] ;

#### Defined in

[args/src/OptionConfig.ts:230](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/OptionConfig.ts#L230)
[args/src/OptionConfig.ts:230](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/OptionConfig.ts#L230)

## Variables

Expand All @@ -510,7 +510,7 @@ A subclass of `Error` that indicates a parsing failure.

#### Defined in

[args/src/ParsingError.ts:6](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/ParsingError.ts#L6)
[args/src/ParsingError.ts:6](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/ParsingError.ts#L6)

---

Expand Down Expand Up @@ -539,7 +539,7 @@ A subclass of `Error` that indicates a validation issue.

#### Defined in

[args/src/ValidationError.ts:6](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/ValidationError.ts#L6)
[args/src/ValidationError.ts:6](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/ValidationError.ts#L6)

## Functions

Expand Down Expand Up @@ -571,4 +571,4 @@ Parsed arguments.

#### Defined in

[args/src/parseArguments.ts:48](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/args/src/parseArguments.ts#L48)
[args/src/parseArguments.ts:48](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/args/src/parseArguments.ts#L48)
10 changes: 5 additions & 5 deletions packages/carson-templates/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@

#### Defined in

[packages/carson-templates/src/main.ts:90](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/carson-templates/src/main.ts#L90)
[packages/carson-templates/src/main.ts:90](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/carson-templates/src/main.ts#L90)

---

Expand All @@ -55,7 +55,7 @@

#### Defined in

[packages/carson-templates/src/main.ts:76](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/carson-templates/src/main.ts#L76)
[packages/carson-templates/src/main.ts:76](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/carson-templates/src/main.ts#L76)

---

Expand All @@ -75,7 +75,7 @@

#### Defined in

[packages/carson-templates/src/main.ts:66](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/carson-templates/src/main.ts#L66)
[packages/carson-templates/src/main.ts:66](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/carson-templates/src/main.ts#L66)

---

Expand All @@ -95,7 +95,7 @@

#### Defined in

[packages/carson-templates/src/main.ts:86](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/carson-templates/src/main.ts#L86)
[packages/carson-templates/src/main.ts:86](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/carson-templates/src/main.ts#L86)

---

Expand All @@ -116,7 +116,7 @@

#### Defined in

[packages/carson-templates/src/main.ts:139](https://github.com/jakubmazanec/js-tools/blob/2adefd4/packages/carson-templates/src/main.ts#L139)
[packages/carson-templates/src/main.ts:139](https://github.com/jakubmazanec/js-tools/blob/9306f5b/packages/carson-templates/src/main.ts#L139)

---

Expand Down
Loading

0 comments on commit 50761cf

Please sign in to comment.