Skip to content

Commit 0ba48a8

Browse files
alpheusmtxalpheusmtx
committed
docs: update apis
1 parent d5e92a7 commit 0ba48a8

28 files changed

Lines changed: 149 additions & 149 deletions

‎apis/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[< Back](./../README.md)
22

3-
# @apst/tsdown v0.2.0
3+
# @apst/tsdown v0.4.0
44

55
## Modules
66

‎apis/core/functions/defineConfig.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
function defineConfig(presets?): UserConfig[];
99
```
1010

11-
Defined in: [functions/define.ts:93](https://github.com/alpheusday/tsdown/blob/c16cc51cd8420341ab6358e8c8cf4db7866559be/package/src/functions/define.ts#L93)
11+
Defined in: [functions/define.ts:93](https://github.com/alpheuscfg/tsdown/blob/d5e92a7e0e98e900a23336bdc59290a94fd02901/package/src/functions/define.ts#L93)
1212

1313
Define tsdown configuration.
1414

@@ -58,10 +58,10 @@ export default defineConfig([
5858
## Call Signature
5959

6060
```ts
61-
function defineConfig(options?, presets?): UserConfig[];
61+
function defineConfig(config?, presets?): UserConfig[];
6262
```
6363

64-
Defined in: [functions/define.ts:118](https://github.com/alpheusday/tsdown/blob/c16cc51cd8420341ab6358e8c8cf4db7866559be/package/src/functions/define.ts#L118)
64+
Defined in: [functions/define.ts:118](https://github.com/alpheuscfg/tsdown/blob/d5e92a7e0e98e900a23336bdc59290a94fd02901/package/src/functions/define.ts#L118)
6565

6666
Define tsdown configuration.
6767

@@ -87,7 +87,7 @@ export default defineConfig(
8787

8888
### Parameters
8989

90-
#### options?
90+
#### config?
9191

9292
`UserConfig`
9393

‎apis/core/variables/OPTIONS_DEFAULT.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
const OPTIONS_DEFAULT: object;
77
```
88

9-
Defined in: [constants/index.ts:6](https://github.com/alpheusday/tsdown/blob/c16cc51cd8420341ab6358e8c8cf4db7866559be/package/src/constants/index.ts#L6)
9+
Defined in: [constants/index.ts:6](https://github.com/alpheuscfg/tsdown/blob/d5e92a7e0e98e900a23336bdc59290a94fd02901/package/src/constants/index.ts#L6)
1010

1111
Default options for `tsdown`.
1212

‎apis/presets/README.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@ Presets module
1111
| [ExtraOptionsCJS](type-aliases/ExtraOptionsCJS.md) | Extra options for the CJS preset. |
1212
| [ExtraOptionsDTS](type-aliases/ExtraOptionsDTS.md) | Extra options for the DTS preset. |
1313
| [ExtraOptionsESM](type-aliases/ExtraOptionsESM.md) | Extra options for the ESM preset. |
14-
| [Preset](type-aliases/Preset.md) | Preset for the build. |
15-
| [PresetOptions](type-aliases/PresetOptions.md) | Preset options. |
16-
| [PresetOptionsCJS](type-aliases/PresetOptionsCJS.md) | Options for the CommonJS preset. |
17-
| [PresetOptionsDTS](type-aliases/PresetOptionsDTS.md) | Options for the DTS preset. |
18-
| [PresetOptionsESM](type-aliases/PresetOptionsESM.md) | Options for the ESModule preset. |
19-
| [PresetOptionsIIFE](type-aliases/PresetOptionsIIFE.md) | Options for the IIFE preset. |
14+
| [Preset](type-aliases/Preset.md) | Preset for the tsdown configuration. |
15+
| [PresetConfigCJS](type-aliases/PresetConfigCJS.md) | Config for the CommonJS preset. |
16+
| [PresetConfigDTS](type-aliases/PresetConfigDTS.md) | Config for the DTS preset. |
17+
| [PresetConfigESM](type-aliases/PresetConfigESM.md) | Config for the ESModule preset. |
18+
| [PresetConfigIIFE](type-aliases/PresetConfigIIFE.md) | Config for the IIFE preset. |
19+
| [PresetContext](type-aliases/PresetContext.md) | Preset options. |
2020
| [PresetResult](type-aliases/PresetResult.md) | Preset result. |
2121

2222
## Functions

‎apis/presets/functions/blankPreset.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@
33
# Function: blankPreset()
44

55
```ts
6-
function blankPreset(options?): Preset;
6+
function blankPreset(config?): Preset;
77
```
88

9-
Defined in: [presets/blank.ts:10](https://github.com/alpheusday/tsdown/blob/c16cc51cd8420341ab6358e8c8cf4db7866559be/package/src/presets/blank.ts#L10)
9+
Defined in: [presets/blank.ts:10](https://github.com/alpheuscfg/tsdown/blob/d5e92a7e0e98e900a23336bdc59290a94fd02901/package/src/presets/blank.ts#L10)
1010

1111
Blank preset.
1212

1313
This preset does not include any default options.
1414

1515
## Parameters
1616

17-
### options?
17+
### config?
1818

1919
`UserConfig`
2020

‎apis/presets/functions/cjsPreset.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,20 @@
33
# Function: cjsPreset()
44

55
```ts
6-
function cjsPreset(options?): Preset;
6+
function cjsPreset(config?): Preset;
77
```
88

9-
Defined in: [presets/cjs.ts:42](https://github.com/alpheusday/tsdown/blob/c16cc51cd8420341ab6358e8c8cf4db7866559be/package/src/presets/cjs.ts#L42)
9+
Defined in: [presets/cjs.ts:42](https://github.com/alpheuscfg/tsdown/blob/d5e92a7e0e98e900a23336bdc59290a94fd02901/package/src/presets/cjs.ts#L42)
1010

1111
CommonJS preset.
1212

1313
This preset includes the default CommonJS options.
1414

1515
## Parameters
1616

17-
### options?
17+
### config?
1818

19-
[`PresetOptionsCJS`](../type-aliases/PresetOptionsCJS.md)
19+
[`PresetConfigCJS`](../type-aliases/PresetConfigCJS.md)
2020

2121
## Returns
2222

‎apis/presets/functions/defaultPreset.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@
33
# Function: defaultPreset()
44

55
```ts
6-
function defaultPreset(options?): Preset;
6+
function defaultPreset(config?): Preset;
77
```
88

9-
Defined in: [presets/default.ts:12](https://github.com/alpheusday/tsdown/blob/c16cc51cd8420341ab6358e8c8cf4db7866559be/package/src/presets/default.ts#L12)
9+
Defined in: [presets/default.ts:12](https://github.com/alpheuscfg/tsdown/blob/d5e92a7e0e98e900a23336bdc59290a94fd02901/package/src/presets/default.ts#L12)
1010

1111
Default preset.
1212

1313
This preset includes the default options only.
1414

1515
## Parameters
1616

17-
### options?
17+
### config?
1818

1919
`UserConfig`
2020

‎apis/presets/functions/dtsPreset.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,20 @@
33
# Function: dtsPreset()
44

55
```ts
6-
function dtsPreset(options?): Preset;
6+
function dtsPreset(config?): Preset;
77
```
88

9-
Defined in: [presets/dts.ts:38](https://github.com/alpheusday/tsdown/blob/c16cc51cd8420341ab6358e8c8cf4db7866559be/package/src/presets/dts.ts#L38)
9+
Defined in: [presets/dts.ts:38](https://github.com/alpheuscfg/tsdown/blob/d5e92a7e0e98e900a23336bdc59290a94fd02901/package/src/presets/dts.ts#L38)
1010

1111
DTS preset.
1212

1313
This preset includes the default DTS options.
1414

1515
## Parameters
1616

17-
### options?
17+
### config?
1818

19-
[`PresetOptionsDTS`](../type-aliases/PresetOptionsDTS.md)
19+
[`PresetConfigDTS`](../type-aliases/PresetConfigDTS.md)
2020

2121
## Returns
2222

‎apis/presets/functions/esmPreset.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,20 @@
33
# Function: esmPreset()
44

55
```ts
6-
function esmPreset(options?): Preset;
6+
function esmPreset(config?): Preset;
77
```
88

9-
Defined in: [presets/esm.ts:42](https://github.com/alpheusday/tsdown/blob/c16cc51cd8420341ab6358e8c8cf4db7866559be/package/src/presets/esm.ts#L42)
9+
Defined in: [presets/esm.ts:42](https://github.com/alpheuscfg/tsdown/blob/d5e92a7e0e98e900a23336bdc59290a94fd02901/package/src/presets/esm.ts#L42)
1010

1111
ESModule preset.
1212

13-
This preset includes the default ESModule options.
13+
This preset includes the default ESModule config.
1414

1515
## Parameters
1616

17-
### options?
17+
### config?
1818

19-
[`PresetOptionsESM`](../type-aliases/PresetOptionsESM.md)
19+
[`PresetConfigESM`](../type-aliases/PresetConfigESM.md)
2020

2121
## Returns
2222

‎apis/presets/functions/iifePreset.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,18 @@
33
# Function: iifePreset()
44

55
```ts
6-
function iifePreset(options?): Preset;
6+
function iifePreset(config?): Preset;
77
```
88

9-
Defined in: [presets/iife.ts:17](https://github.com/alpheusday/tsdown/blob/c16cc51cd8420341ab6358e8c8cf4db7866559be/package/src/presets/iife.ts#L17)
9+
Defined in: [presets/iife.ts:17](https://github.com/alpheuscfg/tsdown/blob/d5e92a7e0e98e900a23336bdc59290a94fd02901/package/src/presets/iife.ts#L17)
1010

1111
IIFE preset.
1212

13-
This preset includes the default IIFE options.
13+
This preset includes the default IIFE config.
1414

1515
## Parameters
1616

17-
### options?
17+
### config?
1818

1919
`UserConfig`
2020

0 commit comments

Comments
 (0)