Skip to content

Commit

Permalink
docs: fix readme links (#767)
Browse files Browse the repository at this point in the history
  • Loading branch information
benmccann authored Nov 27, 2024
1 parent 9f1ad24 commit 51c1dd5
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions packages/vite/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ Wether to remove potentially private metadata from the image, such as exif tags
### extendOutputFormats

`Optional` **extendOutputFormats**(`builtins`): `Record`<`string`,
[`OutputFormat`](../../docs/modules/core_src.md#outputformat)\>
[`OutputFormat`](../../docs/core/src/type-aliases/OutputFormat.md)\>

You can use this option to extend the builtin list of output formats. This list will be merged with the builtin output
formats before determining the format to use.
Expand All @@ -128,20 +128,20 @@ formats before determining the format to use.

#### Parameters

| Name | Type |
| :--------- | :--------------------------------------------------------------------------------- |
| `builtins` | `Record`<`string`, [`OutputFormat`](../../docs/modules/core_src.md#outputformat)\> |
| Name | Type |
| :--------- | :-------------------------------------------------------------------------------------- |
| `builtins` | `Record`<`string`, [`OutputFormat`](../../docs/core/src/type-aliases/OutputFormat.md)\> |

#### Returns

`Record`<`string`, [`OutputFormat`](../../docs/modules/core_src.md#outputformat)\>
`Record`<`string`, [`OutputFormat`](../../docs/core/src/type-aliases/OutputFormat.md)\>

---

### extendTransforms

`Optional` **extendTransforms**(`builtins`):
[`TransformFactory`](../../docs/modules/core_src.md#transformfactory)<`Record`<`string`, `unknown`\>\>[]
[`TransformFactory`](../../docs/core/src/type-aliases/TransformFactory.md)<`Record`<`string`, `unknown`\>\>[]

You can use this option to extend the builtin list of import transforms. This list will be merged with the builtin
transforms before applying them to the input image.
Expand All @@ -150,20 +150,20 @@ transforms before applying them to the input image.

#### Parameters

| Name | Type |
| :--------- | :------------------------------------------------------------------------------------------------------- |
| `builtins` | [`TransformFactory`](../../docs/modules/core_src.md#transformfactory)<`Record`<`string`, `unknown`\>\>[] |
| Name | Type |
| :--------- | :------------------------------------------------------------------------------------------------------------ |
| `builtins` | [`TransformFactory`](../../docs/core/src/type-aliases/TransformFactory.md)<`Record`<`string`, `unknown`\>\>[] |

#### Returns

[`TransformFactory`](../../docs/modules/core_src.md#transformfactory)<`Record`<`string`, `unknown`\>\>[]
[`TransformFactory`](../../docs/core/src/type-aliases/TransformFactory.md)<`Record`<`string`, `unknown`\>\>[]

---

### resolveConfigs

`Optional` **resolveConfigs**: (`entries`: `[string, string[]][]`, `outputFormats`: `Record`<`string`,
[`OutputFormat`](../modules/core_src.md#outputformat)\>) => `Record<string, string | string[]>[]`
[`OutputFormat`](../core/src/README.md#outputformat)\>) => `Record<string, string | string[]>[]`

#### Type declaration

Expand All @@ -174,10 +174,10 @@ that can be given to a the transforms.

##### Parameters

| Name | Type | Description |
| :-------------- | :------------------------------------------------------------------------- | :------------------------ |
| `entries` | `[string, string[]][]` | The url parameter entries |
| `outputFormats` | `Record`<`string`, [`OutputFormat`](../modules/core_src.md#outputformat)\> | - |
| Name | Type | Description |
| :-------------- | :------------------------------------------------------------------------ | :------------------------ |
| `entries` | `[string, string[]][]` | The url parameter entries |
| `outputFormats` | `Record`<`string`, [`OutputFormat`](../core/src/README.md#outputformat)\> | - |

##### Returns

Expand Down

0 comments on commit 51c1dd5

Please sign in to comment.