Skip to content

Commit

Permalink
fix(api): generate qwik api docs again
Browse files Browse the repository at this point in the history
  • Loading branch information
@wmertens
wmertens committed May 1, 2024
1 parent aba6f68 commit 80d2181
Show file tree
Hide file tree
Showing 10 changed files with 12,549 additions and 83 deletions.
2 changes: 1 addition & 1 deletion packages/docs/src/routes/api/qwik-optimizer/api.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -843,4 +843,4 @@
"mdFile": "qwik.versions.md"
}
]
}
}
22 changes: 11 additions & 11 deletions packages/docs/src/routes/api/qwik-server/api.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
}
],
"kind": "Interface",
"content": "```typescript\nexport interface InOrderAuto \n```\n\n\n<table><thead><tr><th>\n\nProperty\n\n\n</th><th>\n\nModifiers\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[maximunChunk?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[maximunInitialChunk?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[strategy](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'auto'\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"content": "```typescript\nexport interface InOrderAuto \n```\n\n\n<table><thead><tr><th>\n\nProperty\n\n\n</th><th>\n\nModifiers\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[maximumChunk?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[maximumInitialChunk?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[strategy](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'auto'\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.inorderauto.md"
},
Expand Down Expand Up @@ -179,9 +179,9 @@
"id": "rendertostream"
}
],
"kind": "Function",
"content": "```typescript\nexport type RenderToStream = (opts: RenderToStreamOptions) => Promise<RenderToStreamResult>;\n```\n**References:** [RenderToStreamOptions](#rendertostreamoptions)<!-- -->, [RenderToStreamResult](#rendertostreamresult)",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/render.ts",
"kind": "Variable",
"content": "Creates a server-side `document`<!-- -->, renders to root node to the document, then serializes the document to a string.\n\n\n```typescript\nrenderToStream2: typeof renderToStream\n```",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/v2-ssr-render2.ts",
"mdFile": "qwik.rendertostream.md"
},
{
Expand All @@ -194,7 +194,7 @@
}
],
"kind": "TypeAlias",
"content": "```typescript\nexport type RenderToStream = (opts: RenderToStreamOptions) => Promise<RenderToStreamResult>;\n```\n**References:** [RenderToStreamOptions](#rendertostreamoptions)<!-- -->, [RenderToStreamResult](#rendertostreamresult)",
"content": "Creates a server-side `document`<!-- -->, renders to root node to the document, then serializes the document to a string.\n\n\n```typescript\nrenderToStream2: typeof renderToStream\n```",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.rendertostream.md"
},
Expand Down Expand Up @@ -235,9 +235,9 @@
"id": "rendertostring"
}
],
"kind": "Function",
"content": "```typescript\nexport type RenderToString = (opts: RenderToStringOptions) => Promise<RenderToStringResult>;\n```\n**References:** [RenderToStringOptions](#rendertostringoptions)<!-- -->, [RenderToStringResult](#rendertostringresult)",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/render.ts",
"kind": "Variable",
"content": "Creates a server-side `document`<!-- -->, renders to root node to the document, then serializes the document to a string.\n\n\n```typescript\nrenderToString2: typeof renderToString\n```",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/v2-ssr-render2.ts",
"mdFile": "qwik.rendertostring.md"
},
{
Expand All @@ -250,7 +250,7 @@
}
],
"kind": "TypeAlias",
"content": "```typescript\nexport type RenderToString = (opts: RenderToStringOptions) => Promise<RenderToStringResult>;\n```\n**References:** [RenderToStringOptions](#rendertostringoptions)<!-- -->, [RenderToStringResult](#rendertostringresult)",
"content": "Creates a server-side `document`<!-- -->, renders to root node to the document, then serializes the document to a string.\n\n\n```typescript\nrenderToString2: typeof renderToString\n```",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.rendertostring.md"
},
Expand Down Expand Up @@ -278,7 +278,7 @@
}
],
"kind": "Interface",
"content": "```typescript\nexport interface RenderToStringResult extends RenderResult \n```\n**Extends:** [RenderResult](#renderresult)\n\n\n<table><thead><tr><th>\n\nProperty\n\n\n</th><th>\n\nModifiers\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[html](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[timing](#)\n\n\n</td><td>\n\n\n</td><td>\n\n{ render: number; snapshot: number; }\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"content": "```typescript\nexport interface RenderToStringResult extends RenderResult \n```\n**Extends:** [RenderResult](#renderresult)\n\n\n<table><thead><tr><th>\n\nProperty\n\n\n</th><th>\n\nModifiers\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[html](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[timing](#)\n\n\n</td><td>\n\n\n</td><td>\n\n{ firstFlush: number; render: number; snapshot: number; }\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.rendertostringresult.md"
},
Expand Down Expand Up @@ -367,4 +367,4 @@
"mdFile": "qwik.versions.md"
}
]
}
}
18 changes: 5 additions & 13 deletions packages/docs/src/routes/api/qwik-server/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Description
</th></tr></thead>
<tbody><tr><td>

[maximunChunk?](#)
[maximumChunk?](#)

</td><td>

Expand All @@ -128,7 +128,7 @@ _(Optional)_
</td></tr>
<tr><td>

[maximunInitialChunk?](#)
[maximumInitialChunk?](#)

</td><td>

Expand Down Expand Up @@ -743,9 +743,7 @@ Creates a server-side `document`, renders to root node to the document, then ser
renderToStream2: typeof renderToStream;
```

**References:** [RenderToStreamOptions](#rendertostreamoptions), [RenderToStreamResult](#rendertostreamresult)

[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/render.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/v2-ssr-render2.ts)

## RenderToStream

Expand All @@ -755,8 +753,6 @@ Creates a server-side `document`, renders to root node to the document, then ser
renderToStream2: typeof renderToStream;
```

**References:** [RenderToStreamOptions](#rendertostreamoptions), [RenderToStreamResult](#rendertostreamresult)

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

## RenderToStreamOptions
Expand Down Expand Up @@ -892,9 +888,7 @@ Creates a server-side `document`, renders to root node to the document, then ser
renderToString2: typeof renderToString;
```
**References:** [RenderToStringOptions](#rendertostringoptions), [RenderToStringResult](#rendertostringresult)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/render.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/v2-ssr-render2.ts)
## RenderToString
Expand All @@ -904,8 +898,6 @@ Creates a server-side `document`, renders to root node to the document, then ser
renderToString2: typeof renderToString;
```
**References:** [RenderToStringOptions](#rendertostringoptions), [RenderToStringResult](#rendertostringresult)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts)
## RenderToStringOptions
Expand Down Expand Up @@ -964,7 +956,7 @@ string
</td><td>
{ render: number; snapshot: number; }
{ firstFlush: number; render: number; snapshot: number; }
</td><td>
Expand Down
Loading

0 comments on commit 80d2181

Please sign in to comment.