Skip to content
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix: export QwikEsbuildPluginApi and update API documentation for ESB…
…uild plugin
  • Loading branch information
thejackshelton committed Jul 7, 2025
commit 5fc885868d91934655fc1b6e9f8ed66730f5500a
16 changes: 15 additions & 1 deletion packages/docs/src/routes/api/qwik-optimizer/api.json
Original file line number Diff line number Diff line change
Expand Up @@ -479,10 +479,24 @@
}
],
"kind": "TypeAlias",
"content": "```typescript\nexport type QwikEsbuildPlugin = Plugin & {\n api: QwikEsbuildPluginApi;\n};\n```",
"content": "```typescript\nexport type QwikEsbuildPlugin = Plugin & {\n api: QwikEsbuildPluginApi;\n};\n```\n**References:** [QwikEsbuildPluginApi](#qwikesbuildpluginapi)",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/esbuild.ts",
"mdFile": "qwik.qwikesbuildplugin.md"
},
{
"name": "QwikEsbuildPluginApi",
"id": "qwikesbuildpluginapi",
"hierarchy": [
{
"name": "QwikEsbuildPluginApi",
"id": "qwikesbuildpluginapi"
}
],
"kind": "TypeAlias",
"content": "```typescript\nexport type QwikEsbuildPluginApi = {\n getOptimizer: () => Optimizer;\n getOptions: () => NormalizedQwikPluginOptions;\n};\n```\n**References:** [Optimizer](#optimizer)",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/esbuild.ts",
"mdFile": "qwik.qwikesbuildpluginapi.md"
},
{
"name": "QwikEsbuildPluginOptions",
"id": "qwikesbuildpluginoptions",
Expand Down
15 changes: 15 additions & 0 deletions packages/docs/src/routes/api/qwik-optimizer/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1497,6 +1497,21 @@ export type QwikEsbuildPlugin = Plugin & {
};
```

**References:** [QwikEsbuildPluginApi](#qwikesbuildpluginapi)

[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/esbuild.ts)

## QwikEsbuildPluginApi

```typescript
export type QwikEsbuildPluginApi = {
getOptimizer: () => Optimizer;
getOptions: () => NormalizedQwikPluginOptions;
};
```

**References:** [Optimizer](#optimizer)

[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/esbuild.ts)

## QwikEsbuildPluginOptions
Expand Down
6 changes: 5 additions & 1 deletion packages/qwik/src/optimizer/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,11 @@ export type {

export type { ExperimentalFeatures, QwikBuildMode, QwikBuildTarget } from './plugins/plugin';
export type { QwikRollupPluginOptions } from './plugins/rollup';
export type { QwikEsbuildPluginOptions, QwikEsbuildPlugin } from './plugins/esbuild';
export type {
QwikEsbuildPluginOptions,
QwikEsbuildPlugin,
QwikEsbuildPluginApi,
} from './plugins/esbuild';
export type {
QwikViteDevResponse,
QwikVitePlugin,
Expand Down
3 changes: 2 additions & 1 deletion packages/qwik/src/optimizer/src/plugins/esbuild.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ import {
type QwikPluginOptions,
} from './plugin';

type QwikEsbuildPluginApi = {
/** @public */
export type QwikEsbuildPluginApi = {
getOptimizer: () => Optimizer;
getOptions: () => NormalizedQwikPluginOptions;
};
Expand Down
10 changes: 7 additions & 3 deletions packages/qwik/src/optimizer/src/qwik.optimizer.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -195,6 +195,12 @@ export type QwikEsbuildPlugin = Plugin_2 & {
api: QwikEsbuildPluginApi;
};

// @public (undocumented)
export type QwikEsbuildPluginApi = {
getOptimizer: () => Optimizer;
getOptions: () => NormalizedQwikPluginOptions;
};

// @public (undocumented)
export interface QwikEsbuildPluginOptions {
assetsDir?: string;
Expand Down Expand Up @@ -332,8 +338,6 @@ export interface QwikVitePluginApi {
getManifest: () => QwikManifest | null;
// (undocumented)
getOptimizer: () => Optimizer | null;
// Warning: (ae-forgotten-export) The symbol "NormalizedQwikPluginOptions" needs to be exported by the entry point index.d.ts
//
// (undocumented)
getOptions: () => NormalizedQwikPluginOptions;
// (undocumented)
Expand Down Expand Up @@ -548,7 +552,7 @@ export const versions: {

// Warnings were encountered during analysis:
//
// /Users/jackshelton/dev/open-source/qwik/dist-dev/dts-out/packages/qwik/src/optimizer/src/plugins/esbuild.d.ts:102:5 - (ae-forgotten-export) The symbol "QwikEsbuildPluginApi" needs to be exported by the entry point index.d.ts
// /Users/jackshelton/dev/open-source/qwik/dist-dev/dts-out/packages/qwik/src/optimizer/src/plugins/esbuild.d.ts:7:5 - (ae-forgotten-export) The symbol "NormalizedQwikPluginOptions" needs to be exported by the entry point index.d.ts

// (No @packageDocumentation comment for this package)

Expand Down
Loading