Skip to content

Commit

Permalink
fix(doc): use no external API references (#12)
Browse files Browse the repository at this point in the history
Signed-off-by: dankeboy36 <[email protected]>
  • Loading branch information
dankeboy36 authored Feb 27, 2024
1 parent ce4fc3d commit c65fb96
Show file tree
Hide file tree
Showing 6 changed files with 66 additions and 453 deletions.
41 changes: 15 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,7 @@ fqbn
### Type Aliases

- [ConfigOption](#configoption)
- [ConfigOptions](#configoptions)
- [ConfigValue](#configvalue)
- [Optional](#optional)

### Functions

Expand All @@ -57,42 +55,33 @@ fqbn

### ConfigOption

Ƭ **ConfigOption**: [`Optional`](#optional)\<`Omit`\<`ApiConfigOption`, `"values"`\>, `"optionLabel"`\> & \{ `values`: [`ConfigValue`](#configvalue)[] }
Ƭ **ConfigOption**: `Object`

Lightweight representation of a custom board [config option](https://arduino.github.io/arduino-cli/latest/rpc/commands/#configoption) provided by the Arduino CLI.

---

### ConfigOptions

Ƭ **ConfigOptions**: `Record`\<`string`, `string`\>
#### Type declaration

An object of custom board config options and the selected values.
| Name | Type | Description |
| :------------- | :--------------------------------------- | :---------------------------------------------------------------------- |
| `option` | `string` | ID of the configuration option. For identifying the option to machines. |
| `optionLabel?` | `string` | Name of the configuration option for identifying the option to humans. |
| `values` | readonly [`ConfigValue`](#configvalue)[] | Possible values of the configuration option. |

---

### ConfigValue

Ƭ **ConfigValue**: [`Optional`](#optional)\<`ApiConfigValue`, `"valueLabel"`\>
Ƭ **ConfigValue**: `Object`

The bare minimum representation of the [`ConfigValue`](https://arduino.github.io/arduino-cli/latest/rpc/commands/#configvalue) provided by the CLI via the gRPC equivalent of the [`board --details`](https://arduino.github.io/arduino-cli/latest/rpc/commands/#boarddetailsrequest) command.

---

### Optional

Ƭ **Optional**\<`T`, `K`\>: `Pick`\<`Partial`\<`T`\>, `K`\> & `Omit`\<`T`, `K`\>

From `T`, make properties those in type `K` optional.

Original source: https://stackoverflow.com/a/61108377/5529090

#### Type parameters
#### Type declaration

| Name | Type |
| :--- | :---------------- |
| `T` | `T` |
| `K` | extends keyof `T` |
| Name | Type | Description |
| :------------ | :-------- | :---------------------------------------------------- |
| `selected` | `boolean` | Whether the configuration option is selected. |
| `value` | `string` | The configuration option value. |
| `valueLabel?` | `string` | Label to identify the configuration option to humans. |

## Functions

Expand Down Expand Up @@ -233,7 +222,7 @@ The unique board identifier per [vendor](#vendor) and [architecture](#arch).

### options

`Optional` `Readonly` **options**: `Readonly`\<[`ConfigOptions`](#configoptions)\>
`Optional` `Readonly` **options**: `Readonly`\<`Record`\<`string`, `string`\>\>

Optional object of custom board options and the selected values.

Expand Down
97 changes: 0 additions & 97 deletions docs/api/README.md

This file was deleted.

Loading

0 comments on commit c65fb96

Please sign in to comment.