jamps/qwik
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

chore(move): Update github references from BuilderIO -> QwikDev (#6111)

Browse Source 
* chore(move): Update github references from BuilderIO -> QwikDev

* fixup! chore(move): Update github references from BuilderIO -> QwikDev
This commit is contained in:
Miško Hevery
2024-04-09 20:00:44 -04:00
committed by GitHub
parent 2d745bf4e3
commit d762be2e0f
125 changed files with 1007 additions and 1011 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.all-contributorsrc
View File

@@ -1,6 +1,6 @@
{
"projectName": "qwik",
"projectOwner": "BuilderIO",
"projectOwner": "QwikDev",
"repoType": "github",
"repoHost": "https://github.com",
"files": ["README.md"],

2
.github/PULL_REQUEST_TEMPLATE.md vendored
View File

@@ -34,7 +34,7 @@ Please include a summary of the change and which issue is fixed. Please also inc
# Checklist:
- [ ] My code follows the [developer guidelines of this project](https://github.com/BuilderIO/qwik/blob/main/CONTRIBUTING.md)
- [ ] My code follows the [developer guidelines of this project](https://github.com/QwikDev/qwik/blob/main/CONTRIBUTING.md)
- [ ] I have performed a self-review of my own code
- [ ] I have made corresponding changes to the documentation
- [ ] Added new tests to cover the fix / functionality

4
.github/workflows/bench.yml vendored
View File

@@ -51,7 +51,7 @@ jobs:
run: cargo +nightly-2021-09-30 bench --workspace | tee output.txt
- name: Download previous benchmark results
run: mkdir raw-data && curl -o raw-data/benchmark-data.json https://raw.githubusercontent.com/BuilderIO/qwik-raw-data/gh-pages/benchmark-data.json
run: mkdir raw-data && curl -o raw-data/benchmark-data.json https://raw.githubusercontent.com/QwikDev/qwik-raw-data/gh-pages/benchmark-data.json
- name: Analyze benchmark result
uses: benchmark-action/github-action-benchmark@v1
@@ -102,5 +102,5 @@ jobs:
clean: false
single-commit: false
git-config-email: github-bot@builder.io
repository-name: BuilderIO/qwik-raw-data
repository-name: QwikDev/qwik-raw-data
commit-message: 'Update'

24
CONTINUOUS_BUILD.md
View File

@@ -4,9 +4,9 @@ This repo contains build artifacts that are generated as part of the continues b
Currently supported artifacts:
- [`@builder.io/qwik`](https://github.com/BuilderIO/qwik-build)
- [`@builder.io/qwik-city`](https://github.com/BuilderIO/qwik-city-build)
- [`@builder.io/qwik-labs`](https://github.com/BuilderIO/qwik-labs-build)
- [`@builder.io/qwik`](https://github.com/QwikDev/qwik-build)
- [`@builder.io/qwik-city`](https://github.com/QwikDev/qwik-city-build)
- [`@builder.io/qwik-labs`](https://github.com/QwikDev/qwik-labs-build)
The build artifact is created if:
@@ -27,9 +27,9 @@ To install a specific build artifact change you `package.json` like so (not all
```json
{
"dependencies": {
"@builder.io/qwik": "github:BuilderIO/qwik-build#SHA",
"@builder.io/qwik-city": "github:BuilderIO/qwik-city-build#SHA",
"@builder.io/qwik-labs": "github:BuilderIO/qwik-labs-build#SHA"
"@builder.io/qwik": "github:QwikDev/qwik-build#SHA",
"@builder.io/qwik-city": "github:QwikDev/qwik-city-build#SHA",
"@builder.io/qwik-labs": "github:QwikDev/qwik-labs-build#SHA"
}
}
```
@@ -37,13 +37,13 @@ To install a specific build artifact change you `package.json` like so (not all
Where `#SHA` is one of the following:
- `#SHA` - Install a specific build SHA. You can get the SHA from:
- [`@builder.io/qwik`](https://github.com/BuilderIO/qwik-build/commits/) commits
- [`@builder.io/qwik-city`](https://github.com/BuilderIO/qwik-city-build/commits/) commits
- [`@builder.io/qwik-labs`](https://github.com/BuilderIO/qwik-labs-build/commits/) commits
- [`@builder.io/qwik`](https://github.com/QwikDev/qwik-build/commits/) commits
- [`@builder.io/qwik-city`](https://github.com/QwikDev/qwik-city-build/commits/) commits
- [`@builder.io/qwik-labs`](https://github.com/QwikDev/qwik-labs-build/commits/) commits
- `#build/name` (or `#main`) - Install a specific `build/*` (or `#main`) branch:
- [`@builder.io/qwik`](https://github.com/BuilderIO/qwik-build/branches/) branches
- [`@builder.io/qwik-city`](https://github.com/BuilderIO/qwik-city-build/branches/) branches
- [`@builder.io/qwik-labs`](https://github.com/BuilderIO/qwik-labs-build/branches/) branches
- [`@builder.io/qwik`](https://github.com/QwikDev/qwik-build/branches/) branches
- [`@builder.io/qwik-city`](https://github.com/QwikDev/qwik-city-build/branches/) branches
- [`@builder.io/qwik-labs`](https://github.com/QwikDev/qwik-labs-build/branches/) branches
> NOTE: Package managers will treat any SHA in the lock file which is on the branch as valid, and so they will not auto upgrade to the latest. For this reason this is not recommended.
## Bisect for regression

10
CONTRIBUTING.md
View File

@@ -22,7 +22,7 @@ We adopt [trunk-based development](https://trunkbaseddevelopment.com/) therefore
### Good first issue
The issues marked with [_Good first issue_](https://github.com/BuilderIO/qwik/issues?q=is%3Aissue+is%3Aopen+label%3A%22COMMUNITY%3A++good+first+issue%22) are a good starting point to familiarize yourself with the project.
The issues marked with [_Good first issue_](https://github.com/QwikDev/qwik/issues?q=is%3Aissue+is%3Aopen+label%3A%22COMMUNITY%3A++good+first+issue%22) are a good starting point to familiarize yourself with the project.
Before solving the problem, please check with the maintainers that the issue is still relevant. Feel free to leave a comment on the issue to show your intention to work on it and prevent other people from unintentionally duplicating your effort.
@@ -36,7 +36,7 @@ Before submitting a pull request, consider the following guidelines:
- Run `pnpm fmt` to lint the code.
- Commit your code with a good commit message [using "Commitizen"](#committing-using-commitizen).
- Push your branch to GitHub: `git push origin my-branch`
- In GitHub, send a pull request to `BuilderIO:main`.
- In GitHub, send a pull request to `QwikDev:main`.
> If you aren't sure your PR is ready, open it as a [draft](https://github.blog/2019-02-14-introducing-draft-pull-requests/) to make it clear to the maintainer.
@@ -307,11 +307,11 @@ This will show an interactive UI to update all dependencies. Be careful about pe
## Starter CLI `create-qwik`
- [Starter CLI](https://github.com/BuilderIO/qwik/blob/main/starters/README.md)
- [Starter CLI](https://github.com/QwikDev/qwik/blob/main/starters/README.md)
## Pull Request
- [Open Qwik in StackBlitz Codeflow](https://pr.new/github.com/BuilderIO/qwik/)
- [Open Qwik in StackBlitz Codeflow](https://pr.new/github.com/QwikDev/qwik/)
- Review PR in StackBlitz
![image](https://user-images.githubusercontent.com/4918140/195581745-8dfca1f9-2dcd-4f6a-b7aa-705f3627f8fa.png)
@@ -344,7 +344,7 @@ pnpm fmt
1. Run `pnpm release.prepare`, which will test, lint and build.
2. Use the interactive UI to select the next version, which will update the `package.json` `version` property, add the git change, and start a commit message.
3. Create a PR with the `package.json` change to merge to `main`.
4. After the `package.json` with the updated version is in `main`, click the [Run Workflow](https://github.com/BuilderIO/qwik/actions/workflows/ci.yml) button from the "Qwik CI" GitHub Action workflow.
4. After the `package.json` with the updated version is in `main`, click the [Run Workflow](https://github.com/QwikDev/qwik/actions/workflows/ci.yml) button from the "Qwik CI" GitHub Action workflow.
5. Select the NPM dist-tag that should be used for this version, then click "Run Workflow".
6. The GitHub Action will dispatch the workflow to build `@builder.io/qwik`, `@builder.io/qwik-city` and each of their submodules, build WASM and native bindings, and validate the package before publishing to NPM.
7. If the build is successful and all tests and validation passes, the workflow will automatically publish to NPM, commit a git tag to the repo, and create a GitHub release.

1
LICENSE
View File

@@ -1,5 +1,6 @@
MIT License
Copyright (c) 2024 QwikDev
Copyright (c) 2021 BuilderIO
Permission is hereby granted, free of charge, to any person obtaining a copy

24
README.md
View File

@@ -1,19 +1,19 @@
<br>
<p align="center">
<img alt="Qwik Logo" width="400" src="https://raw.githubusercontent.com/BuilderIO/qwik/main/.github/assets/qwik-logo.svg" />
<img alt="Qwik Logo" width="400" src="https://raw.githubusercontent.com/QwikDev/qwik/main/.github/assets/qwik-logo.svg" />
</p>
<br>
<p align="center">
<a href="https://github.com/BuilderIO/qwik/actions/workflows/ci.yml"><img src="https://github.com/BuilderIO/qwik/actions/workflows/ci.yml/badge.svg?event=push" alt="Qwik CI"></a>
<a href="https://github.com/BuilderIO/qwik-city-e2e/actions/workflows/azure.yml"><img src="https://github.com/BuilderIO/qwik-city-e2e/actions/workflows/azure.yml/badge.svg" alt="Azure SWA Server"></a>
<a href="https://github.com/BuilderIO/qwik-city-e2e/actions/workflows/cloudflare.yml"><img src="https://github.com/BuilderIO/qwik-city-e2e/actions/workflows/cloudflare.yml/badge.svg" alt="Cloudflare Pages Server"></a>
<a href="https://github.com/BuilderIO/qwik-city-e2e/actions/workflows/netlify.yml"><img src="https://github.com/BuilderIO/qwik-city-e2e/actions/workflows/netlify.yml/badge.svg" alt="Netlify Server"></a>
<a href="https://github.com/BuilderIO/qwik-city-e2e/actions/workflows/node.yml"><img src="https://github.com/BuilderIO/qwik-city-e2e/actions/workflows/node.yml/badge.svg" alt="Node Servers"></a>
<a href="https://github.com/BuilderIO/qwik-city-e2e/actions/workflows/vercel-edge.yml"><img src="https://github.com/BuilderIO/qwik-city-e2e/actions/workflows/vercel-edge.yml/badge.svg" alt="Vercel Edge"></a>
<a href="https://github.com/BuilderIO/qwik-city-e2e/actions/workflows/vercel-serverless.yml"><img src="https://github.com/BuilderIO/qwik-city-e2e/actions/workflows/vercel-serverless.yml/badge.svg" alt="Vercel Serverless"></a>
<a href="https://github.com/BuilderIO/qwik-city-e2e/actions/workflows/cli.yml"><img src="https://github.com/BuilderIO/qwik-city-e2e/actions/workflows/cli.yml/badge.svg" alt="Create Qwik CLI"></a>
<a href="https://github.com/BuilderIO/qwik-city-e2e/actions/workflows/deno.yml"><img src="https://github.com/BuilderIO/qwik-city-e2e/actions/workflows/deno.yml/badge.svg" alt="Deno Server"></a>
<a href="https://github.com/BuilderIO/qwik-city-e2e/actions/workflows/aws.yml"><img src="https://github.com/BuilderIO/qwik-city-e2e/actions/workflows/aws.yml/badge.svg" alt="AWS Server"></a>
<a href="https://github.com/QwikDev/qwik/actions/workflows/ci.yml"><img src="https://github.com/QwikDev/qwik/actions/workflows/ci.yml/badge.svg?event=push" alt="Qwik CI"></a>
<a href="https://github.com/QwikDev/qwik-city-e2e/actions/workflows/azure.yml"><img src="https://github.com/QwikDev/qwik-city-e2e/actions/workflows/azure.yml/badge.svg" alt="Azure SWA Server"></a>
<a href="https://github.com/QwikDev/qwik-city-e2e/actions/workflows/cloudflare.yml"><img src="https://github.com/QwikDev/qwik-city-e2e/actions/workflows/cloudflare.yml/badge.svg" alt="Cloudflare Pages Server"></a>
<a href="https://github.com/QwikDev/qwik-city-e2e/actions/workflows/netlify.yml"><img src="https://github.com/QwikDev/qwik-city-e2e/actions/workflows/netlify.yml/badge.svg" alt="Netlify Server"></a>
<a href="https://github.com/QwikDev/qwik-city-e2e/actions/workflows/node.yml"><img src="https://github.com/QwikDev/qwik-city-e2e/actions/workflows/node.yml/badge.svg" alt="Node Servers"></a>
<a href="https://github.com/QwikDev/qwik-city-e2e/actions/workflows/vercel-edge.yml"><img src="https://github.com/QwikDev/qwik-city-e2e/actions/workflows/vercel-edge.yml/badge.svg" alt="Vercel Edge"></a>
<a href="https://github.com/QwikDev/qwik-city-e2e/actions/workflows/vercel-serverless.yml"><img src="https://github.com/QwikDev/qwik-city-e2e/actions/workflows/vercel-serverless.yml/badge.svg" alt="Vercel Serverless"></a>
<a href="https://github.com/QwikDev/qwik-city-e2e/actions/workflows/cli.yml"><img src="https://github.com/QwikDev/qwik-city-e2e/actions/workflows/cli.yml/badge.svg" alt="Create Qwik CLI"></a>
<a href="https://github.com/QwikDev/qwik-city-e2e/actions/workflows/deno.yml"><img src="https://github.com/QwikDev/qwik-city-e2e/actions/workflows/deno.yml/badge.svg" alt="Deno Server"></a>
<a href="https://github.com/QwikDev/qwik-city-e2e/actions/workflows/aws.yml"><img src="https://github.com/QwikDev/qwik-city-e2e/actions/workflows/aws.yml/badge.svg" alt="AWS Server"></a>
</p>
<br>
<br>
@@ -57,7 +57,7 @@ bun create qwik@latest
## Development
- See [Contributing.md](https://github.com/BuilderIO/qwik/blob/main/CONTRIBUTING.md) for more information on how to build Qwik from the source and contribute!
- See [Contributing.md](https://github.com/QwikDev/qwik/blob/main/CONTRIBUTING.md) for more information on how to build Qwik from the source and contribute!
## Related

2
packages/create-qwik/index.ts
View File

@@ -44,7 +44,7 @@ function checkNodeVersion() {
if (Number(minorVersion) < 11) {
console.error(
red(
`Node.js 18.11 or higher is REQUIRED. From Node 18.0.0 to 18.11.0, there is a bug preventing correct behaviour of Qwik. You are currently running Node.js ${version}. https://github.com/BuilderIO/qwik/issues/3035`
`Node.js 18.11 or higher is REQUIRED. From Node 18.0.0 to 18.11.0, there is a bug preventing correct behaviour of Qwik. You are currently running Node.js ${version}. https://github.com/QwikDev/qwik/issues/3035`
)
);
}

4
packages/create-qwik/package.json
View File

@@ -4,7 +4,7 @@
"version": "1.5.2",
"author": "Builder.io Team",
"bin": "./create-qwik.cjs",
"bugs": "https://github.com/BuilderIO/qwik/issues",
"bugs": "https://github.com/QwikDev/qwik/issues",
"devDependencies": {
"@clack/prompts": "^0.7.0",
"@types/yargs": "^17.0.32",
@@ -35,7 +35,7 @@
"main": "./index.cjs",
"repository": {
"type": "git",
"url": "https://github.com/BuilderIO/qwik.git",
"url": "https://github.com/QwikDev/qwik.git",
"directory": "packages/create-qwik"
}
}

2
packages/docs/contributors.ts
View File

@@ -36,7 +36,7 @@ async function updateGithubCommits(filePath: string) {
const gm = matter.read(filePath);
const repoPath = path.relative(rootDir, filePath).replace(/\\/g, '/');
const url = new URL(`https://api.github.com/repos/BuilderIO/qwik/commits`);
const url = new URL(`https://api.github.com/repos/QwikDev/qwik/commits`);
url.searchParams.set('since', new Date('2022-01-01').toISOString());
url.searchParams.set('path', repoPath);

2
packages/docs/package.json
View File

@@ -3,7 +3,7 @@
"description": "Qwik Docs Site",
"version": "0.0.1",
"author": "Builder.io Team",
"bugs": "https://github.com/BuilderIO/qwik",
"bugs": "https://github.com/QwikDev/qwik",
"devDependencies": {
"@algolia/autocomplete-core": "1.7.4",
"@algolia/client-search": "4.14.3",

2
packages/docs/scripts/pages.json
View File

@@ -104,7 +104,7 @@
{
"href": "https://qwik.dev",
"tags": "site",
"repo": "https://github.com/BuilderIO/qwik/tree/main/packages/docs"
"repo": "https://github.com/QwikDev/qwik/tree/main/packages/docs"
},
{
"href": "https://pulsestax.com/",

2
packages/docs/src/components/code-sandbox/index.tsx
View File

@@ -63,7 +63,7 @@ export default component$<{
<ul>
<li class="edit">
<a
href={'https://github.com/BuilderIO/qwik/blob/main/packages/docs/' + (url || src)}
href={'https://github.com/QwikDev/qwik/blob/main/packages/docs/' + (url || src)}
rel="noopener"
target="_blank"
title="edit this snippet"

2
packages/docs/src/components/header/header.tsx
View File

@@ -127,7 +127,7 @@ export const Header = component$(() => {
<ThemeToggle />
</li>
<li>
<a href="https://github.com/BuilderIO/qwik" target="_blank" title="GitHub">
<a href="https://github.com/QwikDev/qwik" target="_blank" title="GitHub">
<span class="lg:hidden">GitHub</span>
<span class="hidden lg:block">
<GithubLogo width={22} height={22} />

6
packages/docs/src/components/on-this-page/on-this-page.tsx
View File

@@ -94,7 +94,7 @@ export const OnThisPage = component$(() => {
const githubEditRoute = makeEditPageUrl(url.pathname);
const editUrl = `https://github.com/BuilderIO/qwik/edit/main/packages/docs/src/routes/${githubEditRoute}/index.mdx`;
const editUrl = `https://github.com/QwikDev/qwik/edit/main/packages/docs/src/routes/${githubEditRoute}/index.mdx`;
const OnThisPageMore = [
{
@@ -103,7 +103,7 @@ export const OnThisPage = component$(() => {
icon: EditIcon,
},
{
href: 'https://github.com/BuilderIO/qwik/issues/new/choose',
href: 'https://github.com/QwikDev/qwik/issues/new/choose',
text: 'Create an issue',
icon: AlertIcon,
},
@@ -113,7 +113,7 @@ export const OnThisPage = component$(() => {
icon: ChatIcon,
},
{
href: 'https://github.com/BuilderIO/qwik',
href: 'https://github.com/QwikDev/qwik',
text: 'GitHub',
icon: GithubLogo,
},

2
packages/docs/src/components/qwik-gpt/search.tsx
View File

@@ -144,7 +144,7 @@ export async function resolveContext(docsData: any[]) {
for (const result of docsData) {
const commit_hash = result.commit_hash;
const file_path = result.file;
const url = `https://raw.githubusercontent.com/BuilderIO/qwik/${commit_hash}/${file_path}`;
const url = `https://raw.githubusercontent.com/QwikDev/qwik/${commit_hash}/${file_path}`;
if (!files.has(url)) {
files.set(
url,

2
packages/docs/src/routes/(ecosystem)/ecosystem.json
View File

@@ -277,7 +277,7 @@
},
{
"title": "GitHub",
"href": "https://github.com/BuilderIO/qwik",
"href": "https://github.com/QwikDev/qwik",
"imgSrc": "/ecosystem/github.svg"
},
{

8
packages/docs/src/routes/(ecosystem)/ecosystem/index.tsx
View File

@@ -143,7 +143,7 @@ export default component$(() => {
))}
<AddIntegrationItem
title="Add A Course"
href="https://github.com/BuilderIO/qwik/blob/main/packages/docs/src/routes/(ecosystem)/media/index.tsx"
href="https://github.com/QwikDev/qwik/blob/main/packages/docs/src/routes/(ecosystem)/media/index.tsx"
/>
</ul>
</section>
@@ -200,7 +200,7 @@ export default component$(() => {
))}
<AddIntegrationItem
title="Add A Podcast"
href="https://github.com/BuilderIO/qwik/blob/main/packages/docs/src/routes/(ecosystem)/media/index.tsx"
href="https://github.com/QwikDev/qwik/blob/main/packages/docs/src/routes/(ecosystem)/media/index.tsx"
/>
</ul>
</section>
@@ -229,7 +229,7 @@ export default component$(() => {
))}
<AddIntegrationItem
title="Add A Showcase"
href="https://github.com/BuilderIO/qwik/edit/main/packages/docs/scripts/pages.json"
href="https://github.com/QwikDev/qwik/edit/main/packages/docs/scripts/pages.json"
/>
</ul>
</section>
@@ -258,7 +258,7 @@ export default component$(() => {
))}
<AddIntegrationItem
title="Add A Presentation"
href="https://github.com/BuilderIO/qwik/blob/main/packages/docs/src/routes/(ecosystem)/media/index.tsx"
href="https://github.com/QwikDev/qwik/blob/main/packages/docs/src/routes/(ecosystem)/media/index.tsx"
/>
</ul>
</section>

2
packages/docs/src/routes/(ecosystem)/media/index.tsx
View File

@@ -573,7 +573,7 @@ export default component$(() => {
<p>This page missing any great resources or in need of an update?</p>
<p>
<a
href="https://github.com/BuilderIO/qwik/edit/main/packages/docs/src/routes/(ecosystem)/media/index.tsx"
href="https://github.com/QwikDev/qwik/edit/main/packages/docs/src/routes/(ecosystem)/media/index.tsx"
target="_blank"
class="edit-page"
>

2
packages/docs/src/routes/(ecosystem)/showcase/generated-pages.json
View File

@@ -404,7 +404,7 @@
},
"href": "https://qwik.dev",
"tags": "site",
"repo": "https://github.com/BuilderIO/qwik/tree/main/packages/docs"
"repo": "https://github.com/QwikDev/qwik/tree/main/packages/docs"
},
{
"title": "Pulsestax | Check the uptime and pulse of any website",

2
packages/docs/src/routes/(ecosystem)/showcase/index.tsx
View File

@@ -38,7 +38,7 @@ export default component$(() => {
<p>This page missing any great site or in need of an update?</p>
<p>
<a
href="https://github.com/BuilderIO/qwik/edit/main/packages/docs/scripts/pages.json"
href="https://github.com/QwikDev/qwik/edit/main/packages/docs/scripts/pages.json"
target="_blank"
class="edit-page"
>

6
packages/docs/src/routes/api/qwik-city-middleware-aws-lambda/api.json
View File

@@ -13,7 +13,7 @@
],
"kind": "Function",
"content": "```typescript\nexport declare function createQwikCity(opts: AwsOpt): {\n fixPath: (pathT: string) => string;\n router: (req: import(\"http\").IncomingMessage | import(\"http2\").Http2ServerRequest, res: import(\"http\").ServerResponse<import(\"http\").IncomingMessage>, next: import(\"@builder.io/qwik-city/middleware/node\").NodeRequestNextFunction) => Promise<void>;\n staticFile: (req: import(\"http\").IncomingMessage | import(\"http2\").Http2ServerRequest, res: import(\"http\").ServerResponse<import(\"http\").IncomingMessage>, next: (e?: any) => void) => Promise<void>;\n notFound: (req: import(\"http\").IncomingMessage | import(\"http2\").Http2ServerRequest, res: import(\"http\").ServerResponse<import(\"http\").IncomingMessage>, next: (e: any) => void) => Promise<void>;\n handle: (req: any, res: any) => void;\n};\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nopts\n\n\n</td><td>\n\nAwsOpt\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\n{ fixPath: (pathT: string) =&gt; string; router: (req: import(\"http\").IncomingMessage \\| import(\"http2\").Http2ServerRequest, res: import(\"http\").ServerResponse&lt;import(\"http\").IncomingMessage&gt;, next: import(\"@builder.io/qwik-city/middleware/node\").NodeRequestNextFunction) =&gt; Promise&lt;void&gt;; staticFile: (req: import(\"http\").IncomingMessage \\| import(\"http2\").Http2ServerRequest, res: import(\"http\").ServerResponse&lt;import(\"http\").IncomingMessage&gt;, next: (e?: any) =&gt; void) =&gt; Promise&lt;void&gt;; notFound: (req: import(\"http\").IncomingMessage \\| import(\"http2\").Http2ServerRequest, res: import(\"http\").ServerResponse&lt;import(\"http\").IncomingMessage&gt;, next: (e: any) =&gt; void) =&gt; Promise&lt;void&gt;; handle: (req: any, res: any) =&gt; void; }",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/aws-lambda/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/aws-lambda/index.ts",
"mdFile": "qwik-city.createqwikcity.md"
},
{
@@ -27,7 +27,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface PlatformAwsLambda extends Object \n```\n**Extends:** Object",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/aws-lambda/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/aws-lambda/index.ts",
"mdFile": "qwik-city.platformawslambda.md"
},
{
@@ -41,7 +41,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface QwikCityAwsLambdaOptions extends ServerRenderOptions \n```\n**Extends:** ServerRenderOptions",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/aws-lambda/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/aws-lambda/index.ts",
"mdFile": "qwik-city.qwikcityawslambdaoptions.md"
}
]

6
packages/docs/src/routes/api/qwik-city-middleware-aws-lambda/index.md
View File

@@ -57,7 +57,7 @@ AwsOpt
{ fixPath: (pathT: string) =&gt; string; router: (req: import("http").IncomingMessage \| import("http2").Http2ServerRequest, res: import("http").ServerResponse&lt;import("http").IncomingMessage&gt;, next: import("@builder.io/qwik-city/middleware/node").NodeRequestNextFunction) =&gt; Promise&lt;void&gt;; staticFile: (req: import("http").IncomingMessage \| import("http2").Http2ServerRequest, res: import("http").ServerResponse&lt;import("http").IncomingMessage&gt;, next: (e?: any) =&gt; void) =&gt; Promise&lt;void&gt;; notFound: (req: import("http").IncomingMessage \| import("http2").Http2ServerRequest, res: import("http").ServerResponse&lt;import("http").IncomingMessage&gt;, next: (e: any) =&gt; void) =&gt; Promise&lt;void&gt;; handle: (req: any, res: any) =&gt; void; }
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/aws-lambda/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/aws-lambda/index.ts)
## PlatformAwsLambda
@@ -67,7 +67,7 @@ export interface PlatformAwsLambda extends Object
**Extends:** Object
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/aws-lambda/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/aws-lambda/index.ts)
## QwikCityAwsLambdaOptions
@@ -77,4 +77,4 @@ export interface QwikCityAwsLambdaOptions extends ServerRenderOptions
**Extends:** ServerRenderOptions
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/aws-lambda/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/aws-lambda/index.ts)

6
packages/docs/src/routes/api/qwik-city-middleware-azure-swa/api.json
View File

@@ -13,7 +13,7 @@
],
"kind": "Function",
"content": "```typescript\nexport declare function createQwikCity(opts: QwikCityAzureOptions): AzureFunction;\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nopts\n\n\n</td><td>\n\n[QwikCityAzureOptions](#qwikcityazureoptions)\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nAzureFunction",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/azure-swa/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/azure-swa/index.ts",
"mdFile": "qwik-city.createqwikcity.md"
},
{
@@ -27,7 +27,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface PlatformAzure extends Partial<Context> \n```\n**Extends:** Partial&lt;Context&gt;",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/azure-swa/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/azure-swa/index.ts",
"mdFile": "qwik-city.platformazure.md"
},
{
@@ -41,7 +41,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface QwikCityAzureOptions extends ServerRenderOptions \n```\n**Extends:** ServerRenderOptions",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/azure-swa/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/azure-swa/index.ts",
"mdFile": "qwik-city.qwikcityazureoptions.md"
}
]

6
packages/docs/src/routes/api/qwik-city-middleware-azure-swa/index.md
View File

@@ -41,7 +41,7 @@ opts
AzureFunction
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/azure-swa/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/azure-swa/index.ts)
## PlatformAzure
@@ -51,7 +51,7 @@ export interface PlatformAzure extends Partial<Context>
**Extends:** Partial&lt;Context&gt;
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/azure-swa/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/azure-swa/index.ts)
## QwikCityAzureOptions
@@ -61,4 +61,4 @@ export interface QwikCityAzureOptions extends ServerRenderOptions
**Extends:** ServerRenderOptions
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/azure-swa/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/azure-swa/index.ts)

6
packages/docs/src/routes/api/qwik-city-middleware-cloudflare-pages/api.json
View File

@@ -13,7 +13,7 @@
],
"kind": "Function",
"content": "```typescript\nexport declare function createQwikCity(opts: QwikCityCloudflarePagesOptions): (request: PlatformCloudflarePages['request'], env: Record<string, any> & {\n ASSETS: {\n fetch: (req: Request) => Response;\n };\n}, ctx: PlatformCloudflarePages['ctx']) => Promise<Response>;\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nopts\n\n\n</td><td>\n\n[QwikCityCloudflarePagesOptions](#qwikcitycloudflarepagesoptions)\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\n(request: [PlatformCloudflarePages](#platformcloudflarepages)<!-- -->\\['request'\\], env: Record&lt;string, any&gt; &amp; { ASSETS: { fetch: (req: Request) =&gt; Response; }; }, ctx: [PlatformCloudflarePages](#platformcloudflarepages)<!-- -->\\['ctx'\\]) =&gt; Promise&lt;Response&gt;",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/cloudflare-pages/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/cloudflare-pages/index.ts",
"mdFile": "qwik-city.createqwikcity.md"
},
{
@@ -27,7 +27,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface PlatformCloudflarePages \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[ctx](#)\n\n\n</td><td>\n\n\n</td><td>\n\n{ waitUntil: (promise: Promise&lt;any&gt;) =&gt; void; }\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[env?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRecord&lt;string, any&gt;\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[request](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRequest\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/cloudflare-pages/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/cloudflare-pages/index.ts",
"mdFile": "qwik-city.platformcloudflarepages.md"
},
{
@@ -41,7 +41,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface QwikCityCloudflarePagesOptions extends ServerRenderOptions \n```\n**Extends:** ServerRenderOptions",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/cloudflare-pages/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/cloudflare-pages/index.ts",
"mdFile": "qwik-city.qwikcitycloudflarepagesoptions.md"
}
]

6
packages/docs/src/routes/api/qwik-city-middleware-cloudflare-pages/index.md
View File

@@ -47,7 +47,7 @@ opts
(request: [PlatformCloudflarePages](#platformcloudflarepages)['request'], env: Record&lt;string, any&gt; &amp; { ASSETS: { fetch: (req: Request) =&gt; Response; }; }, ctx: [PlatformCloudflarePages](#platformcloudflarepages)['ctx']) =&gt; Promise&lt;Response&gt;
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/cloudflare-pages/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/cloudflare-pages/index.ts)
## PlatformCloudflarePages
@@ -115,7 +115,7 @@ Request
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/cloudflare-pages/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/cloudflare-pages/index.ts)
## QwikCityCloudflarePagesOptions
@@ -125,4 +125,4 @@ export interface QwikCityCloudflarePagesOptions extends ServerRenderOptions
**Extends:** ServerRenderOptions
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/cloudflare-pages/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/cloudflare-pages/index.ts)

6
packages/docs/src/routes/api/qwik-city-middleware-firebase/api.json
View File

@@ -13,7 +13,7 @@
],
"kind": "Function",
"content": "```typescript\nexport declare function createQwikCity(opts: QwikCityFirebaseOptions): (req: any, res: any) => Promise<void>;\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nopts\n\n\n</td><td>\n\n[QwikCityFirebaseOptions](#qwikcityfirebaseoptions)\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\n(req: any, res: any) =&gt; Promise&lt;void&gt;",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/firebase/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/firebase/index.ts",
"mdFile": "qwik-city.createqwikcity.md"
},
{
@@ -27,7 +27,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface PlatformFirebase extends Object \n```\n**Extends:** Object",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/firebase/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/firebase/index.ts",
"mdFile": "qwik-city.platformfirebase.md"
},
{
@@ -41,7 +41,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface QwikCityFirebaseOptions extends ServerRenderOptions \n```\n**Extends:** ServerRenderOptions",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/firebase/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/firebase/index.ts",
"mdFile": "qwik-city.qwikcityfirebaseoptions.md"
}
]

6
packages/docs/src/routes/api/qwik-city-middleware-firebase/index.md
View File

@@ -41,7 +41,7 @@ opts
(req: any, res: any) =&gt; Promise&lt;void&gt;
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/firebase/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/firebase/index.ts)
## PlatformFirebase
@@ -51,7 +51,7 @@ export interface PlatformFirebase extends Object
**Extends:** Object
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/firebase/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/firebase/index.ts)
## QwikCityFirebaseOptions
@@ -61,4 +61,4 @@ export interface QwikCityFirebaseOptions extends ServerRenderOptions
**Extends:** ServerRenderOptions
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/firebase/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/firebase/index.ts)

6
packages/docs/src/routes/api/qwik-city-middleware-netlify-edge/api.json
View File

@@ -13,7 +13,7 @@
],
"kind": "Function",
"content": "```typescript\nexport declare function createQwikCity(opts: QwikCityNetlifyOptions): (request: Request, context: Context) => Promise<Response>;\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nopts\n\n\n</td><td>\n\n[QwikCityNetlifyOptions](#qwikcitynetlifyoptions)\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\n(request: Request, context: Context) =&gt; Promise&lt;Response&gt;",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/netlify-edge/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/netlify-edge/index.ts",
"mdFile": "qwik-city.createqwikcity.md"
},
{
@@ -27,7 +27,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface PlatformNetlify extends Partial<Omit<Context, 'next' | 'cookies'>> \n```\n**Extends:** Partial&lt;Omit&lt;Context, 'next' \\| 'cookies'&gt;&gt;",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/netlify-edge/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/netlify-edge/index.ts",
"mdFile": "qwik-city.platformnetlify.md"
},
{
@@ -41,7 +41,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface QwikCityNetlifyOptions extends ServerRenderOptions \n```\n**Extends:** ServerRenderOptions",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/netlify-edge/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/netlify-edge/index.ts",
"mdFile": "qwik-city.qwikcitynetlifyoptions.md"
}
]

6
packages/docs/src/routes/api/qwik-city-middleware-netlify-edge/index.md
View File

@@ -41,7 +41,7 @@ opts
(request: Request, context: Context) =&gt; Promise&lt;Response&gt;
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/netlify-edge/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/netlify-edge/index.ts)
## PlatformNetlify
@@ -51,7 +51,7 @@ export interface PlatformNetlify extends Partial<Omit<Context, 'next' | 'cookies
**Extends:** Partial&lt;Omit&lt;Context, 'next' \| 'cookies'&gt;&gt;
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/netlify-edge/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/netlify-edge/index.ts)
## QwikCityNetlifyOptions
@@ -61,4 +61,4 @@ export interface QwikCityNetlifyOptions extends ServerRenderOptions
**Extends:** ServerRenderOptions
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/netlify-edge/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/netlify-edge/index.ts)

8
packages/docs/src/routes/api/qwik-city-middleware-node/api.json
View File

@@ -13,7 +13,7 @@
],
"kind": "Function",
"content": "```typescript\nexport declare function createQwikCity(opts: QwikCityNodeRequestOptions): {\n router: (req: IncomingMessage | Http2ServerRequest, res: ServerResponse, next: NodeRequestNextFunction) => Promise<void>;\n notFound: (req: IncomingMessage | Http2ServerRequest, res: ServerResponse, next: (e: any) => void) => Promise<void>;\n staticFile: (req: IncomingMessage | Http2ServerRequest, res: ServerResponse, next: (e?: any) => void) => Promise<void>;\n};\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nopts\n\n\n</td><td>\n\n[QwikCityNodeRequestOptions](#qwikcitynoderequestoptions)\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\n{ router: (req: IncomingMessage \\| Http2ServerRequest, res: ServerResponse, next: [NodeRequestNextFunction](#noderequestnextfunction)<!-- -->) =&gt; Promise&lt;void&gt;; notFound: (req: IncomingMessage \\| Http2ServerRequest, res: ServerResponse, next: (e: any) =&gt; void) =&gt; Promise&lt;void&gt;; staticFile: (req: IncomingMessage \\| Http2ServerRequest, res: ServerResponse, next: (e?: any) =&gt; void) =&gt; Promise&lt;void&gt;; }",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/node/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/node/index.ts",
"mdFile": "qwik-city.createqwikcity.md"
},
{
@@ -27,7 +27,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface NodeRequestNextFunction \n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/node/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/node/index.ts",
"mdFile": "qwik-city.noderequestnextfunction.md"
},
{
@@ -41,7 +41,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface PlatformNode \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[incomingMessage?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nIncomingMessage \\| Http2ServerRequest\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[node?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[ssr?](#)\n\n\n</td><td>\n\n\n</td><td>\n\ntrue\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/node/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/node/index.ts",
"mdFile": "qwik-city.platformnode.md"
},
{
@@ -55,7 +55,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface QwikCityNodeRequestOptions extends ServerRenderOptions \n```\n**Extends:** ServerRenderOptions\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[getClientConn?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n(req: IncomingMessage \\| Http2ServerRequest) =&gt; ClientConn\n\n\n</td><td>\n\n_(Optional)_ Provide a function that returns a `ClientConn` for the given request.\n\n\n</td></tr>\n<tr><td>\n\n[getOrigin?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n(req: IncomingMessage \\| Http2ServerRequest) =&gt; string \\| null\n\n\n</td><td>\n\n_(Optional)_ Provide a function that computes the origin of the server, used to resolve relative URLs and validate the request origin against CSRF attacks.\n\nWhen not specified, it defaults to the `ORIGIN` environment variable (if set).\n\nIf `ORIGIN` is not set, it's derived from the incoming request, which is not recommended for production use. You can specify the `PROTOCOL_HEADER`<!-- -->, `HOST_HEADER` to `X-Forwarded-Proto` and `X-Forwarded-Host` respectively to override the default behavior.\n\n\n</td></tr>\n<tr><td>\n\n[origin?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[static?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n{ root?: string; cacheControl?: string; }\n\n\n</td><td>\n\n_(Optional)_ Options for serving static files\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/node/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/node/index.ts",
"mdFile": "qwik-city.qwikcitynoderequestoptions.md"
}
]

8
packages/docs/src/routes/api/qwik-city-middleware-node/index.md
View File

@@ -55,7 +55,7 @@ opts
{ router: (req: IncomingMessage \| Http2ServerRequest, res: ServerResponse, next: [NodeRequestNextFunction](#noderequestnextfunction)) =&gt; Promise&lt;void&gt;; notFound: (req: IncomingMessage \| Http2ServerRequest, res: ServerResponse, next: (e: any) =&gt; void) =&gt; Promise&lt;void&gt;; staticFile: (req: IncomingMessage \| Http2ServerRequest, res: ServerResponse, next: (e?: any) =&gt; void) =&gt; Promise&lt;void&gt;; }
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/node/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/node/index.ts)
## NodeRequestNextFunction
@@ -63,7 +63,7 @@ opts
export interface NodeRequestNextFunction
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/node/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/node/index.ts)
## PlatformNode
@@ -135,7 +135,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/node/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/node/index.ts)
## QwikCityNodeRequestOptions
@@ -228,4 +228,4 @@ _(Optional)_ Options for serving static files
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/node/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/node/index.ts)

48
packages/docs/src/routes/api/qwik-city-middleware-request-handler/api.json
View File

@@ -13,7 +13,7 @@
],
"kind": "Class",
"content": "```typescript\nexport declare class AbortMessage \n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/redirect-handler.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/redirect-handler.ts",
"mdFile": "qwik-city.abortmessage.md"
},
{
@@ -27,7 +27,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type CacheControl = CacheControlOptions | number | 'day' | 'week' | 'month' | 'year' | 'no-cache' | 'immutable' | 'private';\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"mdFile": "qwik-city.cachecontrol.md"
},
{
@@ -41,7 +41,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface ClientConn \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[country?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[ip?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"mdFile": "qwik-city.clientconn.md"
},
{
@@ -55,7 +55,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface Cookie \n```\n\n\n<table><thead><tr><th>\n\nMethod\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[delete(name, options)](#cookie-delete)\n\n\n</td><td>\n\nDeletes cookie value by name using the `Response` cookie header.\n\n\n</td></tr>\n<tr><td>\n\n[get(name)](#cookie-get)\n\n\n</td><td>\n\nGets a `Request` cookie header value by name.\n\n\n</td></tr>\n<tr><td>\n\n[getAll()](#cookie-getall)\n\n\n</td><td>\n\nGets all `Request` cookie headers.\n\n\n</td></tr>\n<tr><td>\n\n[has(name)](#cookie-has)\n\n\n</td><td>\n\nChecks if the `Request` cookie header name exists.\n\n\n</td></tr>\n<tr><td>\n\n[headers()](#cookie-headers)\n\n\n</td><td>\n\nReturns an array of all the set `Response` `Set-Cookie` header values.\n\n\n</td></tr>\n<tr><td>\n\n[set(name, value, options)](#cookie-set)\n\n\n</td><td>\n\nSets a `Response` cookie header using the `Set-Cookie` header.\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"mdFile": "qwik-city.cookie.md"
},
{
@@ -69,7 +69,7 @@
],
"kind": "Interface",
"content": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie\n\n\n```typescript\nexport interface CookieOptions \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[domain?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_ Defines the host to which the cookie will be sent. If omitted, this attribute defaults to the host of the current document URL, not including subdomains.\n\n\n</td></tr>\n<tr><td>\n\n[expires?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nDate \\| string\n\n\n</td><td>\n\n_(Optional)_ Indicates the maximum lifetime of the cookie as an HTTP-date timestamp. If both `expires` and `maxAge` are set, `maxAge` has precedence.\n\n\n</td></tr>\n<tr><td>\n\n[httpOnly?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Forbids JavaScript from accessing the cookie, for example, through the `document.cookie` property.\n\n\n</td></tr>\n<tr><td>\n\n[maxAge?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber \\| \\[number, 'seconds' \\| 'minutes' \\| 'hours' \\| 'days' \\| 'weeks'\\]\n\n\n</td><td>\n\n_(Optional)_ Indicates the number of seconds until the cookie expires. A zero or negative number will expire the cookie immediately. If both `expires` and `maxAge` are set, `maxAge` has precedence. You can also use the array syntax to set the max-age using minutes, hours, days or weeks. For example, `{ maxAge: [3, \"days\"] }` would set the cookie to expire in 3 days.\n\n\n</td></tr>\n<tr><td>\n\n[path?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_ Indicates the path that must exist in the requested URL for the browser to send the Cookie header.\n\n\n</td></tr>\n<tr><td>\n\n[sameSite?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'strict' \\| 'lax' \\| 'none' \\| 'Strict' \\| 'Lax' \\| 'None' \\| boolean\n\n\n</td><td>\n\n_(Optional)_ Controls whether or not a cookie is sent with cross-site requests, providing some protection against cross-site request forgery attacks (CSRF).\n\n\n</td></tr>\n<tr><td>\n\n[secure?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Indicates that the cookie is sent to the server only when a request is made with the `https:` scheme (except on localhost)\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"mdFile": "qwik-city.cookieoptions.md"
},
{
@@ -83,7 +83,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface CookieValue \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[json](#)\n\n\n</td><td>\n\n\n</td><td>\n\n&lt;T = unknown&gt;() =&gt; T\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[number](#)\n\n\n</td><td>\n\n\n</td><td>\n\n() =&gt; number\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[value](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"mdFile": "qwik-city.cookievalue.md"
},
{
@@ -97,7 +97,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type DeferReturn<T> = () => Promise<T>;\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"mdFile": "qwik-city.deferreturn.md"
},
{
@@ -128,7 +128,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface EnvGetter \n```\n\n\n<table><thead><tr><th>\n\nMethod\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[get(key)](#)\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"mdFile": "qwik-city.envgetter.md"
},
{
@@ -176,7 +176,7 @@
],
"kind": "Function",
"content": "```typescript\nexport declare function getErrorHtml(status: number, e: any): string;\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nstatus\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\ne\n\n\n</td><td>\n\nany\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nstring",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/error-handler.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/error-handler.ts",
"mdFile": "qwik-city.geterrorhtml.md"
},
{
@@ -224,7 +224,7 @@
],
"kind": "Function",
"content": "```typescript\nmergeHeadersCookies: (headers: Headers, cookies: CookieInterface) => Headers\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nheaders\n\n\n</td><td>\n\nHeaders\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\ncookies\n\n\n</td><td>\n\n[CookieInterface](#cookie)\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nHeaders",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/cookie.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/cookie.ts",
"mdFile": "qwik-city.mergeheaderscookies.md"
},
{
@@ -238,7 +238,7 @@
],
"kind": "Class",
"content": "```typescript\nexport declare class RedirectMessage extends AbortMessage \n```\n**Extends:** [AbortMessage](#abortmessage)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/redirect-handler.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/redirect-handler.ts",
"mdFile": "qwik-city.redirectmessage.md"
},
{
@@ -252,7 +252,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface RequestEvent<PLATFORM = QwikCityPlatform> extends RequestEventCommon<PLATFORM> \n```\n**Extends:** [RequestEventCommon](#requesteventcommon)<!-- -->&lt;PLATFORM&gt;\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[exited](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\nTrue if the middleware chain has finished executing.\n\n\n</td></tr>\n<tr><td>\n\n[getWritableStream](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n() =&gt; WritableStream&lt;Uint8Array&gt;\n\n\n</td><td>\n\nLow-level access to write to the HTTP response stream. Once `getWritableStream()` is called, the status and headers can no longer be modified and will be sent over the network.\n\n\n</td></tr>\n<tr><td>\n\n[headersSent](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\nTrue if headers have been sent, preventing any more headers from being set.\n\n\n</td></tr>\n<tr><td>\n\n[next](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n() =&gt; Promise&lt;void&gt;\n\n\n</td><td>\n\nInvoke the next middleware function in the chain.\n\nNOTE: Ensure that the call to `next()` is `await`<!-- -->ed.\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"mdFile": "qwik-city.requestevent.md"
},
{
@@ -266,7 +266,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface RequestEventAction<PLATFORM = QwikCityPlatform> extends RequestEventCommon<PLATFORM> \n```\n**Extends:** [RequestEventCommon](#requesteventcommon)<!-- -->&lt;PLATFORM&gt;\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[fail](#)\n\n\n</td><td>\n\n\n</td><td>\n\n&lt;T extends Record&lt;string, any&gt;&gt;(status: number, returnData: T) =&gt; FailReturn&lt;T&gt;\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"mdFile": "qwik-city.requesteventaction.md"
},
{
@@ -280,7 +280,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface RequestEventBase<PLATFORM = QwikCityPlatform> \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[basePathname](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\nThe base pathname of the request, which can be configured at build time. Defaults to `/`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[cacheControl](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(cacheControl: [CacheControl](#cachecontrol)<!-- -->, target?: CacheControlTarget) =&gt; void\n\n\n</td><td>\n\nConvenience method to set the Cache-Control header. Depending on your CDN, you may want to add another cacheControl with the second argument set to `CDN-Cache-Control` or any other value (we provide the most common values for auto-complete, but you can use any string you want).\n\nSee https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control and https://qwik.dev/docs/caching/\\#CDN-Cache-Controls for more information.\n\n\n</td></tr>\n<tr><td>\n\n[clientConn](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n[ClientConn](#clientconn)\n\n\n</td><td>\n\nProvides information about the client connection, such as the IP address and the country the request originated from.\n\n\n</td></tr>\n<tr><td>\n\n[cookie](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n[Cookie](#cookie)\n\n\n</td><td>\n\nHTTP request and response cookie. Use the `get()` method to retrieve a request cookie value. Use the `set()` method to set a response cookie value.\n\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies\n\n\n</td></tr>\n<tr><td>\n\n[env](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n[EnvGetter](#envgetter)\n\n\n</td><td>\n\nPlatform provided environment variables.\n\n\n</td></tr>\n<tr><td>\n\n[headers](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nHeaders\n\n\n</td><td>\n\nHTTP response headers. Notice it will be empty until you first add a header. If you want to read the request headers, use `request.headers` instead.\n\nhttps://developer.mozilla.org/en-US/docs/Glossary/Response\\_header\n\n\n</td></tr>\n<tr><td>\n\n[method](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\nHTTP request method.\n\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Methods\n\n\n</td></tr>\n<tr><td>\n\n[params](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nReadonly&lt;Record&lt;string, string&gt;&gt;\n\n\n</td><td>\n\nURL path params which have been parsed from the current url pathname segments. Use `query` to instead retrieve the query string search params.\n\n\n</td></tr>\n<tr><td>\n\n[parseBody](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n() =&gt; Promise&lt;unknown&gt;\n\n\n</td><td>\n\nThis method will check the request headers for a `Content-Type` header and parse the body accordingly. It supports `application/json`<!-- -->, `application/x-www-form-urlencoded`<!-- -->, and `multipart/form-data` content types.\n\nIf the `Content-Type` header is not set, it will return `null`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[pathname](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\nURL pathname. Does not include the protocol, domain, query string (search params) or hash.\n\nhttps://developer.mozilla.org/en-US/docs/Web/API/URL/pathname\n\n\n</td></tr>\n<tr><td>\n\n[platform](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nPLATFORM\n\n\n</td><td>\n\nPlatform specific data and functions\n\n\n</td></tr>\n<tr><td>\n\n[query](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nURLSearchParams\n\n\n</td><td>\n\nURL Query Strings (URL Search Params). Use `params` to instead retrieve the route params found in the url pathname.\n\nhttps://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams\n\n\n</td></tr>\n<tr><td>\n\n[request](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nRequest\n\n\n</td><td>\n\nHTTP request information.\n\n\n</td></tr>\n<tr><td>\n\n[sharedMap](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nMap&lt;string, any&gt;\n\n\n</td><td>\n\nShared Map across all the request handlers. Every HTTP request will get a new instance of the shared map. The shared map is useful for sharing data between request handlers.\n\n\n</td></tr>\n<tr><td>\n\n[signal](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nAbortSignal\n\n\n</td><td>\n\nRequest's AbortSignal (same as `request.signal`<!-- -->). This signal indicates that the request has been aborted.\n\n\n</td></tr>\n<tr><td>\n\n[url](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nURL\n\n\n</td><td>\n\nHTTP request URL.\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"mdFile": "qwik-city.requesteventbase.md"
},
{
@@ -294,7 +294,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface RequestEventCommon<PLATFORM = QwikCityPlatform> extends RequestEventBase<PLATFORM> \n```\n**Extends:** [RequestEventBase](#requesteventbase)<!-- -->&lt;PLATFORM&gt;\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[error](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(statusCode: ErrorCodes, message: string) =&gt; ErrorResponse\n\n\n</td><td>\n\nWhen called, the response will immediately end with the given status code. This could be useful to end a response with `404`<!-- -->, and use the 404 handler in the routes directory. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status for which status code should be used.\n\n\n</td></tr>\n<tr><td>\n\n[exit](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n() =&gt; [AbortMessage](#abortmessage)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[html](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(statusCode: StatusCodes, html: string) =&gt; [AbortMessage](#abortmessage)\n\n\n</td><td>\n\nConvenience method to send an HTML body response. The response will be automatically set the `Content-Type` header to`text/html; charset=utf-8`<!-- -->. An `html()` response can only be called once.\n\n\n</td></tr>\n<tr><td>\n\n[json](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(statusCode: StatusCodes, data: any) =&gt; [AbortMessage](#abortmessage)\n\n\n</td><td>\n\nConvenience method to JSON stringify the data and send it in the response. The response will be automatically set the `Content-Type` header to `application/json; charset=utf-8`<!-- -->. A `json()` response can only be called once.\n\n\n</td></tr>\n<tr><td>\n\n[locale](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(local?: string) =&gt; string\n\n\n</td><td>\n\nWhich locale the content is in.\n\nThe locale value can be retrieved from selected methods using `getLocale()`<!-- -->:\n\n\n</td></tr>\n<tr><td>\n\n[redirect](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(statusCode: RedirectCode, url: string) =&gt; [RedirectMessage](#redirectmessage)\n\n\n</td><td>\n\nURL to redirect to. When called, the response will immediately end with the correct redirect status and headers.\n\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Redirections\n\n\n</td></tr>\n<tr><td>\n\n[send](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nSendMethod\n\n\n</td><td>\n\nSend a body response. The `Content-Type` response header is not automatically set when using `send()` and must be set manually. A `send()` response can only be called once.\n\n\n</td></tr>\n<tr><td>\n\n[status](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(statusCode?: StatusCodes) =&gt; number\n\n\n</td><td>\n\nHTTP response status code. Sets the status code when called with an argument. Always returns the status code, so calling `status()` without an argument will can be used to return the current status code.\n\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Status\n\n\n</td></tr>\n<tr><td>\n\n[text](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n(statusCode: StatusCodes, text: string) =&gt; [AbortMessage](#abortmessage)\n\n\n</td><td>\n\nConvenience method to send an text body response. The response will be automatically set the `Content-Type` header to`text/plain; charset=utf-8`<!-- -->. An `text()` response can only be called once.\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"mdFile": "qwik-city.requesteventcommon.md"
},
{
@@ -308,7 +308,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface RequestEventLoader<PLATFORM = QwikCityPlatform> extends RequestEventAction<PLATFORM> \n```\n**Extends:** [RequestEventAction](#requesteventaction)<!-- -->&lt;PLATFORM&gt;\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[defer](#)\n\n\n</td><td>\n\n\n</td><td>\n\n&lt;T&gt;(returnData: Promise&lt;T&gt; \\| (() =&gt; Promise&lt;T&gt;)) =&gt; [DeferReturn](#deferreturn)<!-- -->&lt;T&gt;\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[resolveValue](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[ResolveValue](#resolvevalue)\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"mdFile": "qwik-city.requesteventloader.md"
},
{
@@ -322,7 +322,7 @@
],
"kind": "Function",
"content": "```typescript\nexport type RequestHandler<PLATFORM = QwikCityPlatform> = (ev: RequestEvent<PLATFORM>) => Promise<void> | void;\n```\n**References:** [RequestEvent](#requestevent)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/request-handler.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/request-handler.ts",
"mdFile": "qwik-city.requesthandler.md"
},
{
@@ -336,7 +336,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type RequestHandler<PLATFORM = QwikCityPlatform> = (ev: RequestEvent<PLATFORM>) => Promise<void> | void;\n```\n**References:** [RequestEvent](#requestevent)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"mdFile": "qwik-city.requesthandler.md"
},
{
@@ -350,7 +350,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface ResolveSyncValue \n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"mdFile": "qwik-city.resolvesyncvalue.md"
},
{
@@ -364,7 +364,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface ResolveValue \n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"mdFile": "qwik-city.resolvevalue.md"
},
{
@@ -378,7 +378,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface ServerRenderOptions extends RenderOptions \n```\n**Extends:** RenderOptions\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[checkOrigin?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Protection against cross-site request forgery (CSRF) attacks.\n\nWhen `true`<!-- -->, for every incoming POST, PUT, PATCH, or DELETE form submissions, the request origin is checked to match the server's origin.\n\nBe careful when disabling this option as it may lead to CSRF attacks.\n\nDefaults to `true`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[qwikCityPlan](#)\n\n\n</td><td>\n\n\n</td><td>\n\nQwikCityPlan\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[render](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRender\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"mdFile": "qwik-city.serverrenderoptions.md"
},
{
@@ -392,7 +392,7 @@
],
"kind": "Interface",
"content": "Request event created by the server.\n\n\n```typescript\nexport interface ServerRequestEvent<T = unknown> \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[env](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[EnvGetter](#envgetter)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[getClientConn](#)\n\n\n</td><td>\n\n\n</td><td>\n\n() =&gt; [ClientConn](#clientconn)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[getWritableStream](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[ServerResponseHandler](#serverresponsehandler)<!-- -->&lt;T&gt;\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[locale](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring \\| undefined\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[mode](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[ServerRequestMode](#serverrequestmode)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[platform](#)\n\n\n</td><td>\n\n\n</td><td>\n\nQwikCityPlatform\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[request](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRequest\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[url](#)\n\n\n</td><td>\n\n\n</td><td>\n\nURL\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"mdFile": "qwik-city.serverrequestevent.md"
},
{
@@ -406,7 +406,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type ServerRequestMode = 'dev' | 'static' | 'server';\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"mdFile": "qwik-city.serverrequestmode.md"
},
{
@@ -420,7 +420,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type ServerResponseHandler<T = any> = (status: number, headers: Headers, cookies: Cookie, resolve: (response: T) => void, requestEv: RequestEventInternal) => WritableStream<Uint8Array>;\n```\n**References:** [Cookie](#cookie)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts",
"mdFile": "qwik-city.serverresponsehandler.md"
},
{

48
packages/docs/src/routes/api/qwik-city-middleware-request-handler/index.md
View File

@@ -10,7 +10,7 @@ title: \@builder.io/qwik-city/middleware/request-handler API Reference
export declare class AbortMessage
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/redirect-handler.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/redirect-handler.ts)
## CacheControl
@@ -27,7 +27,7 @@ export type CacheControl =
| "private";
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
## ClientConn
@@ -84,7 +84,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
## Cookie
@@ -157,7 +157,7 @@ Sets a `Response` cookie header using the `Set-Cookie` header.
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
## CookieOptions
@@ -291,7 +291,7 @@ _(Optional)_ Indicates that the cookie is sent to the server only when a request
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
## CookieValue
@@ -357,7 +357,7 @@ string
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
## DeferReturn
@@ -365,7 +365,7 @@ string
export type DeferReturn<T> = () => Promise<T>;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
## delete
@@ -441,7 +441,7 @@ Description
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
## get
@@ -538,7 +538,7 @@ any
string
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/error-handler.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/error-handler.ts)
## has
@@ -635,7 +635,7 @@ cookies
Headers
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/cookie.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/cookie.ts)
## RedirectMessage
@@ -645,7 +645,7 @@ export declare class RedirectMessage extends AbortMessage
**Extends:** [AbortMessage](#abortmessage)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/redirect-handler.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/redirect-handler.ts)
## RequestEvent
@@ -744,7 +744,7 @@ NOTE: Ensure that the call to `next()` is `await`ed.
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
## RequestEventAction
@@ -786,7 +786,7 @@ Description
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
## RequestEventBase
@@ -1099,7 +1099,7 @@ HTTP request URL.
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
## RequestEventCommon
@@ -1285,7 +1285,7 @@ Convenience method to send an text body response. The response will be automatic
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
## RequestEventLoader
@@ -1340,7 +1340,7 @@ Description
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
## requestHandler
@@ -1352,7 +1352,7 @@ export type RequestHandler<PLATFORM = QwikCityPlatform> = (
**References:** [RequestEvent](#requestevent)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/request-handler.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/request-handler.ts)
## RequestHandler
@@ -1364,7 +1364,7 @@ export type RequestHandler<PLATFORM = QwikCityPlatform> = (
**References:** [RequestEvent](#requestevent)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
## ResolveSyncValue
@@ -1372,7 +1372,7 @@ export type RequestHandler<PLATFORM = QwikCityPlatform> = (
export interface ResolveSyncValue
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
## ResolveValue
@@ -1380,7 +1380,7 @@ export interface ResolveSyncValue
export interface ResolveValue
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
## ServerRenderOptions
@@ -1456,7 +1456,7 @@ Render
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
## ServerRequestEvent
@@ -1589,7 +1589,7 @@ URL
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
## ServerRequestMode
@@ -1597,7 +1597,7 @@ URL
export type ServerRequestMode = "dev" | "static" | "server";
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
## ServerResponseHandler
@@ -1613,7 +1613,7 @@ export type ServerResponseHandler<T = any> = (
**References:** [Cookie](#cookie)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/request-handler/types.ts)
## set

6
packages/docs/src/routes/api/qwik-city-middleware-vercel-edge/api.json
View File

@@ -13,7 +13,7 @@
],
"kind": "Function",
"content": "```typescript\nexport declare function createQwikCity(opts: QwikCityVercelEdgeOptions): (request: Request) => Promise<Response>;\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nopts\n\n\n</td><td>\n\n[QwikCityVercelEdgeOptions](#qwikcityverceledgeoptions)\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\n(request: Request) =&gt; Promise&lt;Response&gt;",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/vercel-edge/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/vercel-edge/index.ts",
"mdFile": "qwik-city.createqwikcity.md"
},
{
@@ -27,7 +27,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface PlatformVercel \n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/vercel-edge/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/vercel-edge/index.ts",
"mdFile": "qwik-city.platformvercel.md"
},
{
@@ -41,7 +41,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface QwikCityVercelEdgeOptions extends ServerRenderOptions \n```\n**Extends:** ServerRenderOptions",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/vercel-edge/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/vercel-edge/index.ts",
"mdFile": "qwik-city.qwikcityverceledgeoptions.md"
}
]

6
packages/docs/src/routes/api/qwik-city-middleware-vercel-edge/index.md
View File

@@ -41,7 +41,7 @@ opts
(request: Request) =&gt; Promise&lt;Response&gt;
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/vercel-edge/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/vercel-edge/index.ts)
## PlatformVercel
@@ -49,7 +49,7 @@ opts
export interface PlatformVercel
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/vercel-edge/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/vercel-edge/index.ts)
## QwikCityVercelEdgeOptions
@@ -59,4 +59,4 @@ export interface QwikCityVercelEdgeOptions extends ServerRenderOptions
**Extends:** ServerRenderOptions
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/vercel-edge/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/vercel-edge/index.ts)

8
packages/docs/src/routes/api/qwik-city-static/api.json
View File

@@ -13,7 +13,7 @@
],
"kind": "Function",
"content": "Use this function when SSG should be generated from another module, such as a Vite plugin. This function's should be passed the paths of the entry module and Qwik City Plan.\n\n\n```typescript\nexport declare function generate(opts: StaticGenerateOptions): Promise<StaticGenerateResult>;\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nopts\n\n\n</td><td>\n\n[StaticGenerateOptions](#staticgenerateoptions)\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nPromise&lt;[StaticGenerateResult](#staticgenerateresult)<!-- -->&gt;",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/static/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/static/index.ts",
"mdFile": "qwik-city.generate.md"
},
{
@@ -27,7 +27,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface StaticGenerateOptions extends StaticGenerateRenderOptions \n```\n**Extends:** [StaticGenerateRenderOptions](#staticgeneraterenderoptions)\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[basePathname?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_ Defaults to `/`\n\n\n</td></tr>\n<tr><td>\n\n[qwikCityPlanModulePath](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\nPath to the Qwik City Plan module exporting the default `@qwik-city-plan`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[renderModulePath](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\nPath to the SSR module exporting the default render function. In most cases it'll be `./src/entry.ssr.tsx`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[rootDir?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/static/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/static/types.ts",
"mdFile": "qwik-city.staticgenerateoptions.md"
},
{
@@ -41,7 +41,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface StaticGenerateRenderOptions extends RenderOptions \n```\n**Extends:** RenderOptions\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[emit404Pages?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Set to `false` if the static build should not write custom or default `404.html` pages. Defaults to `true`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[emitData?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Set to `false` if the generated `q-data.json` data files should not be written to disk. Defaults to `true`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[emitHtml?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Set to `false` if the generated static HTML files should not be written to disk. Setting to `false` is useful if the SSG should only write the `q-data.json` files to disk. Defaults to `true`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[exclude?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\\[\\]\n\n\n</td><td>\n\n_(Optional)_ Defines file system routes relative to the source `routes` directory that should not be static generated. Accepts wildcard behavior. This should not include the \"base\" pathname. `exclude` always takes priority over `include`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[include?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\\[\\]\n\n\n</td><td>\n\n_(Optional)_ Defines file system routes relative to the source `routes` directory that should be static generated. Accepts wildcard behavior. This should not include the \"base\" pathname. If not provided, all routes will be static generated. `exclude` always takes priority over `include`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[log?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'debug'\n\n\n</td><td>\n\n_(Optional)_ Log level.\n\n\n</td></tr>\n<tr><td>\n\n[maxTasksPerWorker?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n_(Optional)_ Maximum number of tasks to be running at one time per worker. Defaults to `20`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[maxWorkers?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n_(Optional)_ Maximum number of workers to use while generating the static pages. Defaults to the number of CPUs available.\n\n\n</td></tr>\n<tr><td>\n\n[origin](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\nThe URL `origin`<!-- -->, which is a combination of the scheme (protocol) and hostname (domain). For example, `https://qwik.dev` has the protocol `https://` and domain `qwik.dev`<!-- -->. However, the `origin` does not include a `pathname`<!-- -->.\n\nThe `origin` is used to provide a full URL during Static Site Generation (SSG), and to simulate a complete URL rather than just the `pathname`<!-- -->. For example, in order to render a correct canonical tag URL or URLs within the `sitemap.xml`<!-- -->, the `origin` must be provided too.\n\nIf the site also starts with a pathname other than `/`<!-- -->, please use the `basePathname` option in the Qwik City config options.\n\n\n</td></tr>\n<tr><td>\n\n[outDir](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\nFile system directory where the static files should be written.\n\n\n</td></tr>\n<tr><td>\n\n[sitemapOutFile?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring \\| null\n\n\n</td><td>\n\n_(Optional)_ File system path to write the `sitemap.xml` to. Defaults to `sitemap.xml` and written to the root of the `outDir`<!-- -->. Setting to `null` will prevent the sitemap from being created.\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/static/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/static/types.ts",
"mdFile": "qwik-city.staticgeneraterenderoptions.md"
},
{
@@ -55,7 +55,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface StaticGenerateResult \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[duration](#)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[errors](#)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[rendered](#)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[staticPaths](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\\[\\]\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/static/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/static/types.ts",
"mdFile": "qwik-city.staticgenerateresult.md"
}
]

8
packages/docs/src/routes/api/qwik-city-static/index.md
View File

@@ -43,7 +43,7 @@ opts
Promise&lt;[StaticGenerateResult](#staticgenerateresult)&gt;
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/static/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/static/index.ts)
## StaticGenerateOptions
@@ -132,7 +132,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/static/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/static/types.ts)
## StaticGenerateRenderOptions
@@ -330,7 +330,7 @@ _(Optional)_ File system path to write the `sitemap.xml` to. Defaults to `sitema
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/static/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/static/types.ts)
## StaticGenerateResult
@@ -409,4 +409,4 @@ string[]
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/static/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/static/types.ts)

4
packages/docs/src/routes/api/qwik-city-vite-azure-swa/api.json
View File

@@ -13,7 +13,7 @@
],
"kind": "Function",
"content": "```typescript\nexport declare function azureSwaAdapter(opts?: AzureSwaAdapterOptions): any;\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nopts\n\n\n</td><td>\n\n[AzureSwaAdapterOptions](#azureswaadapteroptions)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nany",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/azure-swa/vite/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/azure-swa/vite/index.ts",
"mdFile": "qwik-city.azureswaadapter.md"
},
{
@@ -27,7 +27,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface AzureSwaAdapterOptions extends ServerAdapterOptions \n```\n**Extends:** ServerAdapterOptions",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/azure-swa/vite/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/azure-swa/vite/index.ts",
"mdFile": "qwik-city.azureswaadapteroptions.md"
}
]

4
packages/docs/src/routes/api/qwik-city-vite-azure-swa/index.md
View File

@@ -41,7 +41,7 @@ _(Optional)_
any
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/azure-swa/vite/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/azure-swa/vite/index.ts)
## AzureSwaAdapterOptions
@@ -51,4 +51,4 @@ export interface AzureSwaAdapterOptions extends ServerAdapterOptions
**Extends:** ServerAdapterOptions
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/azure-swa/vite/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/azure-swa/vite/index.ts)

4
packages/docs/src/routes/api/qwik-city-vite-bun-server/api.json
View File

@@ -13,7 +13,7 @@
],
"kind": "Function",
"content": "> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.\n> \n\n\n\n```typescript\nexport declare function bunServerAdapter(opts?: bunServerAdapterOptions): any;\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nopts\n\n\n</td><td>\n\n[bunServerAdapterOptions](#bunserveradapteroptions)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nany",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/bun-server/vite/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/bun-server/vite/index.ts",
"mdFile": "qwik-city.bunserveradapter.md"
},
{
@@ -27,7 +27,7 @@
],
"kind": "Interface",
"content": "> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.\n> \n\n\n\n```typescript\nexport interface bunServerAdapterOptions extends ServerAdapterOptions \n```\n**Extends:** ServerAdapterOptions\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[name?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n**_(ALPHA)_** _(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/bun-server/vite/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/bun-server/vite/index.ts",
"mdFile": "qwik-city.bunserveradapteroptions.md"
}
]

4
packages/docs/src/routes/api/qwik-city-vite-bun-server/index.md
View File

@@ -43,7 +43,7 @@ _(Optional)_
any
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/bun-server/vite/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/bun-server/vite/index.ts)
## bunServerAdapterOptions
@@ -89,4 +89,4 @@ string
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/bun-server/vite/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/bun-server/vite/index.ts)

4
packages/docs/src/routes/api/qwik-city-vite-cloud-run/api.json
View File

@@ -13,7 +13,7 @@
],
"kind": "Function",
"content": "```typescript\nexport declare function cloudRunAdapter(opts?: CloudRunAdapterOptions): any;\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nopts\n\n\n</td><td>\n\n[CloudRunAdapterOptions](#cloudrunadapteroptions)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nany",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/cloud-run/vite/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/cloud-run/vite/index.ts",
"mdFile": "qwik-city.cloudrunadapter.md"
},
{
@@ -27,7 +27,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface CloudRunAdapterOptions extends ServerAdapterOptions \n```\n**Extends:** ServerAdapterOptions",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/cloud-run/vite/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/cloud-run/vite/index.ts",
"mdFile": "qwik-city.cloudrunadapteroptions.md"
}
]

4
packages/docs/src/routes/api/qwik-city-vite-cloud-run/index.md
View File

@@ -41,7 +41,7 @@ _(Optional)_
any
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/cloud-run/vite/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/cloud-run/vite/index.ts)
## CloudRunAdapterOptions
@@ -51,4 +51,4 @@ export interface CloudRunAdapterOptions extends ServerAdapterOptions
**Extends:** ServerAdapterOptions
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/cloud-run/vite/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/cloud-run/vite/index.ts)

4
packages/docs/src/routes/api/qwik-city-vite-cloudflare-pages/api.json
View File

@@ -13,7 +13,7 @@
],
"kind": "Function",
"content": "```typescript\nexport declare function cloudflarePagesAdapter(opts?: CloudflarePagesAdapterOptions): any;\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nopts\n\n\n</td><td>\n\n[CloudflarePagesAdapterOptions](#cloudflarepagesadapteroptions)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nany",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/cloudflare-pages/vite/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/cloudflare-pages/vite/index.ts",
"mdFile": "qwik-city.cloudflarepagesadapter.md"
},
{
@@ -27,7 +27,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface CloudflarePagesAdapterOptions extends ServerAdapterOptions \n```\n**Extends:** ServerAdapterOptions\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[functionRoutes?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Determines if the build should generate the function invocation routes `_routes.json` file.\n\nhttps://developers.cloudflare.com/pages/platform/functions/routing/\\#functions-invocation-routes\n\nDefaults to `true`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[staticPaths?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\\[\\]\n\n\n</td><td>\n\n_(Optional)_ Manually add pathnames that should be treated as static paths and not SSR. For example, when these pathnames are requested, their response should come from a static file, rather than a server-side rendered response.\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/cloudflare-pages/vite/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/cloudflare-pages/vite/index.ts",
"mdFile": "qwik-city.cloudflarepagesadapteroptions.md"
}
]

4
packages/docs/src/routes/api/qwik-city-vite-cloudflare-pages/index.md
View File

@@ -43,7 +43,7 @@ _(Optional)_
any
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/cloudflare-pages/vite/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/cloudflare-pages/vite/index.ts)
## CloudflarePagesAdapterOptions
@@ -106,4 +106,4 @@ _(Optional)_ Manually add pathnames that should be treated as static paths and n
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/cloudflare-pages/vite/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/cloudflare-pages/vite/index.ts)

4
packages/docs/src/routes/api/qwik-city-vite-netlify-edge/api.json
View File

@@ -13,7 +13,7 @@
],
"kind": "Function",
"content": "```typescript\nexport declare function netlifyEdgeAdapter(opts?: NetlifyEdgeAdapterOptions): any;\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nopts\n\n\n</td><td>\n\n[NetlifyEdgeAdapterOptions](#netlifyedgeadapteroptions)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nany",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/netlify-edge/vite/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/netlify-edge/vite/index.ts",
"mdFile": "qwik-city.netlifyedgeadapter.md"
},
{
@@ -27,7 +27,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface NetlifyEdgeAdapterOptions extends ServerAdapterOptions \n```\n**Extends:** ServerAdapterOptions\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[excludedPath?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring \\| string\\[\\]\n\n\n</td><td>\n\n_(Optional)_ Manually add path pattern that should be excluded from the edge function routes that are created by the 'manifest.json' file.\n\nIf not specified, the following paths are excluded by default:\n\n- /build/\\* - /favicon.ico - /robots.txt - /mainifest.json - /\\~partytown/\\* - /service-worker.js - /sitemap.xml\n\nhttps://docs.netlify.com/edge-functions/declarations/\\#declare-edge-functions-in-netlify-toml\n\n\n</td></tr>\n<tr><td>\n\n[functionRoutes?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Determines if the build should generate the edge functions declarations `manifest.json` file.\n\nhttps://docs.netlify.com/edge-functions/declarations/\n\nDefaults to `true`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[staticPaths?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\\[\\]\n\n\n</td><td>\n\n_(Optional)_ Manually add pathnames that should be treated as static paths and not SSR. For example, when these pathnames are requested, their response should come from a static file, rather than a server-side rendered response.\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/netlify-edge/vite/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/netlify-edge/vite/index.ts",
"mdFile": "qwik-city.netlifyedgeadapteroptions.md"
}
]

4
packages/docs/src/routes/api/qwik-city-vite-netlify-edge/index.md
View File

@@ -43,7 +43,7 @@ _(Optional)_
any
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/netlify-edge/vite/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/netlify-edge/vite/index.ts)
## NetlifyEdgeAdapterOptions
@@ -127,4 +127,4 @@ _(Optional)_ Manually add pathnames that should be treated as static paths and n
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/netlify-edge/vite/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/netlify-edge/vite/index.ts)

4
packages/docs/src/routes/api/qwik-city-vite-node-server/api.json
View File

@@ -13,7 +13,7 @@
],
"kind": "Function",
"content": "> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.\n> \n\n\n\n```typescript\nexport declare function nodeServerAdapter(opts?: NodeServerAdapterOptions): any;\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nopts\n\n\n</td><td>\n\n[NodeServerAdapterOptions](#nodeserveradapteroptions)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nany",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/node-server/vite/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/node-server/vite/index.ts",
"mdFile": "qwik-city.nodeserveradapter.md"
},
{
@@ -27,7 +27,7 @@
],
"kind": "Interface",
"content": "> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.\n> \n\n\n\n```typescript\nexport interface NodeServerAdapterOptions extends ServerAdapterOptions \n```\n**Extends:** ServerAdapterOptions\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[name?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n**_(ALPHA)_** _(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/node-server/vite/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/node-server/vite/index.ts",
"mdFile": "qwik-city.nodeserveradapteroptions.md"
}
]

4
packages/docs/src/routes/api/qwik-city-vite-node-server/index.md
View File

@@ -43,7 +43,7 @@ _(Optional)_
any
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/node-server/vite/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/node-server/vite/index.ts)
## NodeServerAdapterOptions
@@ -89,4 +89,4 @@ string
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/node-server/vite/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/node-server/vite/index.ts)

4
packages/docs/src/routes/api/qwik-city-vite-static/api.json
View File

@@ -13,7 +13,7 @@
],
"kind": "Function",
"content": "```typescript\nexport declare function staticAdapter(opts: StaticGenerateAdapterOptions): any;\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nopts\n\n\n</td><td>\n\n[StaticGenerateAdapterOptions](#staticgenerateadapteroptions)\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nany",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/static/vite/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/static/vite/index.ts",
"mdFile": "qwik-city.staticadapter.md"
},
{
@@ -27,7 +27,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface StaticGenerateAdapterOptions extends Omit<StaticGenerateRenderOptions, 'outDir'> \n```\n**Extends:** Omit&lt;StaticGenerateRenderOptions, 'outDir'&gt;",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/static/vite/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/static/vite/index.ts",
"mdFile": "qwik-city.staticgenerateadapteroptions.md"
}
]

4
packages/docs/src/routes/api/qwik-city-vite-static/index.md
View File

@@ -39,7 +39,7 @@ opts
any
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/static/vite/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/static/vite/index.ts)
## StaticGenerateAdapterOptions
@@ -49,4 +49,4 @@ export interface StaticGenerateAdapterOptions extends Omit<StaticGenerateRenderO
**Extends:** Omit&lt;StaticGenerateRenderOptions, 'outDir'&gt;
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/static/vite/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/static/vite/index.ts)

4
packages/docs/src/routes/api/qwik-city-vite-vercel/api.json
View File

@@ -13,7 +13,7 @@
],
"kind": "Function",
"content": "```typescript\nexport declare function vercelEdgeAdapter(opts?: VercelEdgeAdapterOptions): any;\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nopts\n\n\n</td><td>\n\n[VercelEdgeAdapterOptions](#verceledgeadapteroptions)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nany",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/vercel-edge/vite/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/vercel-edge/vite/index.ts",
"mdFile": "qwik-city.verceledgeadapter.md"
},
{
@@ -27,7 +27,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface VercelEdgeAdapterOptions extends ServerAdapterOptions \n```\n**Extends:** ServerAdapterOptions\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[outputConfig?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Determines if the build should auto-generate the `.vercel/output/config.json` config.\n\nDefaults to `true`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[staticPaths?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\\[\\]\n\n\n</td><td>\n\n_(Optional)_ Manually add pathnames that should be treated as static paths and not SSR. For example, when these pathnames are requested, their response should come from a static file, rather than a server-side rendered response.\n\n\n</td></tr>\n<tr><td>\n\n[target?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'webworker' \\| 'node'\n\n\n</td><td>\n\n_(Optional)_ Define the `target` property in the `ssr` object in the `vite.config.ts` file.\n\nDefaults to `webworker`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[vcConfigEntryPoint?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_ The `entrypoint` property in the `.vc-config.json` file. Indicates the initial file where code will be executed for the Edge Function.\n\nDefaults to `entry.vercel-edge.js`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[vcConfigEnvVarsInUse?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\\[\\]\n\n\n</td><td>\n\n_(Optional)_ The `envVarsInUse` property in the `.vc-config.json` file. List of environment variable names that will be available for the Edge Function to utilize.\n\nDefaults to `undefined`<!-- -->.\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/vercel-edge/vite/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/vercel-edge/vite/index.ts",
"mdFile": "qwik-city.verceledgeadapteroptions.md"
}
]

4
packages/docs/src/routes/api/qwik-city-vite-vercel/index.md
View File

@@ -41,7 +41,7 @@ _(Optional)_
any
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/vercel-edge/vite/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/vercel-edge/vite/index.ts)
## VercelEdgeAdapterOptions
@@ -153,4 +153,4 @@ Defaults to `undefined`.
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters/vercel-edge/vite/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters/vercel-edge/vite/index.ts)

130
packages/docs/src/routes/api/qwik-city/api.json
View File

@@ -13,7 +13,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type Action<RETURN, INPUT = Record<string, unknown>, OPTIONAL extends boolean = true> = {\n (): ActionStore<RETURN, INPUT, OPTIONAL>;\n};\n```\n**References:** [ActionStore](#actionstore)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.action.md"
},
{
@@ -27,7 +27,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type ActionConstructor = {\n <OBJ extends Record<string, any> | void | null, VALIDATOR extends TypedDataValidator, REST extends [DataValidator, ...DataValidator[]]>(actionQrl: (data: GetValidatorType<VALIDATOR>, event: RequestEventAction) => ValueOrPromise<OBJ>, options: {\n readonly id?: string;\n readonly validation: [VALIDATOR, ...REST];\n }): Action<StrictUnion<OBJ | FailReturn<zod.typeToFlattenedError<GetValidatorType<VALIDATOR>>> | FailReturn<FailOfRest<REST>>>, GetValidatorType<VALIDATOR>, false>;\n <OBJ extends Record<string, any> | void | null, VALIDATOR extends TypedDataValidator>(actionQrl: (data: GetValidatorType<VALIDATOR>, event: RequestEventAction) => ValueOrPromise<OBJ>, options: {\n readonly id?: string;\n readonly validation: [VALIDATOR];\n }): Action<StrictUnion<OBJ | FailReturn<zod.typeToFlattenedError<GetValidatorType<VALIDATOR>>>>, GetValidatorType<VALIDATOR>, false>;\n <OBJ extends Record<string, any> | void | null, REST extends [DataValidator, ...DataValidator[]]>(actionQrl: (data: JSONObject, event: RequestEventAction) => ValueOrPromise<OBJ>, options: {\n readonly id?: string;\n readonly validation: REST;\n }): Action<StrictUnion<OBJ | FailReturn<FailOfRest<REST>>>>;\n <OBJ extends Record<string, any> | void | null, VALIDATOR extends TypedDataValidator, REST extends [DataValidator, ...DataValidator[]]>(actionQrl: (data: GetValidatorType<VALIDATOR>, event: RequestEventAction) => ValueOrPromise<OBJ>, options: VALIDATOR, ...rest: REST): Action<StrictUnion<OBJ | FailReturn<zod.typeToFlattenedError<GetValidatorType<VALIDATOR>>> | FailReturn<FailOfRest<REST>>>, GetValidatorType<VALIDATOR>, false>;\n <OBJ extends Record<string, any> | void | null, VALIDATOR extends TypedDataValidator>(actionQrl: (data: GetValidatorType<VALIDATOR>, event: RequestEventAction) => ValueOrPromise<OBJ>, options: VALIDATOR): Action<StrictUnion<OBJ | FailReturn<zod.typeToFlattenedError<GetValidatorType<VALIDATOR>>>>, GetValidatorType<VALIDATOR>, false>;\n <OBJ extends Record<string, any> | void | null, REST extends [DataValidator, ...DataValidator[]]>(actionQrl: (form: JSONObject, event: RequestEventAction) => ValueOrPromise<OBJ>, ...rest: REST): Action<StrictUnion<OBJ | FailReturn<FailOfRest<REST>>>>;\n <OBJ>(actionQrl: (form: JSONObject, event: RequestEventAction) => ValueOrPromise<OBJ>, options?: {\n readonly id?: string;\n }): Action<StrictUnion<OBJ>>;\n};\n```\n**References:** [TypedDataValidator](#typeddatavalidator)<!-- -->, [DataValidator](#datavalidator)<!-- -->, [GetValidatorType](#getvalidatortype)<!-- -->, [Action](#action)<!-- -->, [StrictUnion](#strictunion)<!-- -->, [FailReturn](#failreturn)<!-- -->, [FailOfRest](#failofrest)<!-- -->, [JSONObject](#jsonobject)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.actionconstructor.md"
},
{
@@ -41,7 +41,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type ActionReturn<RETURN> = {\n readonly status?: number;\n readonly value: RETURN;\n};\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.actionreturn.md"
},
{
@@ -55,7 +55,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type ActionStore<RETURN, INPUT, OPTIONAL extends boolean = true> = {\n readonly actionPath: string;\n readonly isRunning: boolean;\n readonly status?: number;\n readonly formData: FormData | undefined;\n readonly value: RETURN | undefined;\n readonly submit: QRL<OPTIONAL extends true ? (form?: INPUT | FormData | SubmitEvent) => Promise<ActionReturn<RETURN>> : (form: INPUT | FormData | SubmitEvent) => Promise<ActionReturn<RETURN>>>;\n};\n```\n**References:** [ActionReturn](#actionreturn)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.actionstore.md"
},
{
@@ -69,7 +69,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface ContentHeading \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[id](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[level](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[text](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.contentheading.md"
},
{
@@ -83,7 +83,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface ContentMenu \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[href?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[items?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n[ContentMenu](#contentmenu)<!-- -->\\[\\]\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[text](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.contentmenu.md"
},
{
@@ -97,7 +97,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type DataValidator<T extends Record<string, any> = {}> = {\n validate(ev: RequestEvent, data: unknown): Promise<ValidatorReturn<T>>;\n};\n```\n**References:** [ValidatorReturn](#validatorreturn)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.datavalidator.md"
},
{
@@ -111,7 +111,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type DocumentHead = DocumentHeadValue | ((props: DocumentHeadProps) => DocumentHeadValue);\n```\n**References:** [DocumentHeadValue](#documentheadvalue)<!-- -->, [DocumentHeadProps](#documentheadprops)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.documenthead.md"
},
{
@@ -125,7 +125,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface DocumentHeadProps extends RouteLocation \n```\n**Extends:** [RouteLocation](#routelocation)\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[head](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n[ResolvedDocumentHead](#resolveddocumenthead)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[resolveValue](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nResolveSyncValue\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[withLocale](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n&lt;T&gt;(fn: () =&gt; T) =&gt; T\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.documentheadprops.md"
},
{
@@ -139,7 +139,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface DocumentHeadValue<FrontMatter extends Record<string, any> = Record<string, unknown>> \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[frontmatter?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nReadonly&lt;FrontMatter&gt;\n\n\n</td><td>\n\n_(Optional)_ Arbitrary object containing custom data. When the document head is created from markdown files, the frontmatter attributes that are not recognized as a well-known meta names (such as title, description, author, etc...), are stored in this property.\n\n\n</td></tr>\n<tr><td>\n\n[links?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nreadonly [DocumentLink](#documentlink)<!-- -->\\[\\]\n\n\n</td><td>\n\n_(Optional)_ Used to manually append `<link>` elements to the `<head>`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[meta?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nreadonly [DocumentMeta](#documentmeta)<!-- -->\\[\\]\n\n\n</td><td>\n\n_(Optional)_ Used to manually set meta tags in the head. Additionally, the `data` property could be used to set arbitrary data which the `<head>` component could later use to generate `<meta>` tags.\n\n\n</td></tr>\n<tr><td>\n\n[scripts?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nreadonly [DocumentScript](#documentscript)<!-- -->\\[\\]\n\n\n</td><td>\n\n_(Optional)_ Used to manually append `<script>` elements to the `<head>`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[styles?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nreadonly [DocumentStyle](#documentstyle)<!-- -->\\[\\]\n\n\n</td><td>\n\n_(Optional)_ Used to manually append `<style>` elements to the `<head>`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[title?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_ Sets `document.title`<!-- -->.\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.documentheadvalue.md"
},
{
@@ -153,7 +153,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface DocumentLink \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[as?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[crossorigin?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[disabled?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[href?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[hreflang?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[id?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[imagesizes?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[imagesrcset?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[integrity?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[key?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[media?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[prefetch?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[referrerpolicy?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[rel?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[sizes?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[title?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[type?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.documentlink.md"
},
{
@@ -167,7 +167,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface DocumentMeta \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[content?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[httpEquiv?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[itemprop?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[key?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[media?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[name?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[property?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.documentmeta.md"
},
{
@@ -181,7 +181,7 @@
],
"kind": "Interface",
"content": "> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.\n> \n\n\n\n```typescript\nexport interface DocumentScript \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[key?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n**_(ALPHA)_** _(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[props?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nReadonly&lt;QwikIntrinsicElements\\['script'\\]&gt;\n\n\n</td><td>\n\n**_(ALPHA)_** _(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[script?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n**_(ALPHA)_** _(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.documentscript.md"
},
{
@@ -195,7 +195,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface DocumentStyle \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[key?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[props?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nReadonly&lt;QwikIntrinsicElements\\['style'\\]&gt;\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[style](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.documentstyle.md"
},
{
@@ -209,7 +209,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type FailOfRest<REST extends readonly DataValidator[]> = REST extends readonly DataValidator<infer ERROR>[] ? ERROR : never;\n```\n**References:** [DataValidator](#datavalidator)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.failofrest.md"
},
{
@@ -223,7 +223,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type FailReturn<T> = T & Failed;\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.failreturn.md"
},
{
@@ -237,7 +237,7 @@
],
"kind": "Function",
"content": "```typescript\nForm: <O, I>({ action, spaReset, reloadDocument, onSubmit$, ...rest }: FormProps<O, I>, key: string | null) => import(\"@builder.io/qwik\").JSXOutput\n```\n\n\n<table><thead><tr><th>\n\nParameter\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{ action, spaReset, reloadDocument, onSubmit$, ...rest }\n\n\n</td><td>\n\n[FormProps](#formprops)<!-- -->&lt;O, I&gt;\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\nkey\n\n\n</td><td>\n\nstring \\| null\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nimport(\"@builder.io/qwik\").JSXOutput",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/form-component.tsx",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/form-component.tsx",
"mdFile": "qwik-city.form.md"
},
{
@@ -251,7 +251,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface FormProps<O, I> extends Omit<QwikJSX.IntrinsicElements['form'], 'action' | 'method'> \n```\n**Extends:** Omit&lt;QwikJSX.IntrinsicElements\\['form'\\], 'action' \\| 'method'&gt;\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[action?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[ActionStore](#actionstore)<!-- -->&lt;O, I, true \\| false&gt;\n\n\n</td><td>\n\n_(Optional)_ Reference to the action returned by `action()`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[key?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring \\| number \\| null\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[onSubmit$?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n(event: Event, form: HTMLFormElement) =&gt; ValueOrPromise&lt;void&gt;\n\n\n</td><td>\n\n_(Optional)_ Event handler executed right when the form is submitted.\n\n\n</td></tr>\n<tr><td>\n\n[onSubmitCompleted$?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n(event: CustomEvent&lt;[FormSubmitCompletedDetail](#formsubmitsuccessdetail)<!-- -->&lt;O&gt;&gt;, form: HTMLFormElement) =&gt; ValueOrPromise&lt;void&gt;\n\n\n</td><td>\n\n_(Optional)_ Event handler executed right after the action is executed successfully and returns some data.\n\n\n</td></tr>\n<tr><td>\n\n[reloadDocument?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ When `true` the form submission will cause a full page reload, even if SPA mode is enabled and JS is available.\n\n\n</td></tr>\n<tr><td>\n\n[spaReset?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ When `true` all the form inputs will be reset in SPA mode, just like happens in a full page form submission.\n\nDefaults to `false`\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/form-component.tsx",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/form-component.tsx",
"mdFile": "qwik-city.formprops.md"
},
{
@@ -265,7 +265,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface FormSubmitCompletedDetail<T> \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[status](#)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[value](#)\n\n\n</td><td>\n\n\n</td><td>\n\nT\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/form-component.tsx",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/form-component.tsx",
"mdFile": "qwik-city.formsubmitsuccessdetail.md"
},
{
@@ -279,7 +279,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type GetValidatorType<VALIDATOR extends TypedDataValidator> = VALIDATOR extends TypedDataValidator<infer TYPE> ? zod.infer<TYPE> : never;\n```\n**References:** [TypedDataValidator](#typeddatavalidator)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.getvalidatortype.md"
},
{
@@ -293,7 +293,7 @@
],
"kind": "Variable",
"content": "```typescript\nglobalAction$: ActionConstructor\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"mdFile": "qwik-city.globalaction_.md"
},
{
@@ -307,7 +307,7 @@
],
"kind": "Variable",
"content": "```typescript\nglobalActionQrl: ActionConstructorQRL\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"mdFile": "qwik-city.globalactionqrl.md"
},
{
@@ -321,7 +321,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type JSONObject = {\n [x: string]: JSONValue;\n};\n```\n**References:** [JSONValue](#jsonvalue)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.jsonobject.md"
},
{
@@ -335,7 +335,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type JSONValue = string | number | boolean | {\n [x: string]: JSONValue;\n} | Array<JSONValue>;\n```\n**References:** [JSONValue](#jsonvalue)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.jsonvalue.md"
},
{
@@ -349,7 +349,7 @@
],
"kind": "Variable",
"content": "```typescript\nLink: import(\"@builder.io/qwik\").Component<LinkProps>\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/link-component.tsx",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/link-component.tsx",
"mdFile": "qwik-city.link.md"
},
{
@@ -363,7 +363,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface LinkProps extends AnchorAttributes \n```\n**Extends:** AnchorAttributes\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[prefetch?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean \\| 'js'\n\n\n</td><td>\n\n_(Optional)_ \\*\\*Defaults to \\_true\\_.\\*\\*\n\nWhether Qwik should prefetch and cache the target page of this \\*\\*`Link`<!-- -->\\*\\*, this includes invoking any \\*\\*`routeLoader$`<!-- -->\\*\\*, \\*\\*`onGet`<!-- -->\\*\\*, etc.\n\nThis \\*\\*improves UX performance\\*\\* for client-side (\\*\\*SPA\\*\\*) navigations.\n\nPrefetching occurs when a the Link enters the viewport in production (\\*\\*`on:qvisibile`<!-- -->\\*\\*), or with \\*\\*`mouseover`<!-- -->/`focus`<!-- -->\\*\\* during dev.\n\nPrefetching will not occur if the user has the \\*\\*data saver\\*\\* setting enabled.\n\nSetting this value to \\*\\*`\"js\"`<!-- -->\\*\\* will prefetch only javascript bundles required to render this page on the client, \\*\\*`false`<!-- -->\\*\\* will disable prefetching altogether.\n\n\n</td></tr>\n<tr><td>\n\n[reload?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[replaceState?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[scroll?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/link-component.tsx",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/link-component.tsx",
"mdFile": "qwik-city.linkprops.md"
},
{
@@ -377,7 +377,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type Loader<RETURN> = {\n (): LoaderSignal<RETURN>;\n};\n```\n**References:** [LoaderSignal](#loadersignal)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.loader_2.md"
},
{
@@ -391,7 +391,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type LoaderSignal<TYPE> = TYPE extends () => ValueOrPromise<infer VALIDATOR> ? ReadonlySignal<ValueOrPromise<VALIDATOR>> : ReadonlySignal<TYPE>;\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.loadersignal.md"
},
{
@@ -405,7 +405,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type MenuData = [pathname: string, menuLoader: MenuModuleLoader];\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.menudata.md"
},
{
@@ -419,7 +419,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type NavigationType = 'initial' | 'form' | 'link' | 'popstate';\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.navigationtype.md"
},
{
@@ -433,7 +433,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface PageModule extends RouteModule \n```\n**Extends:** RouteModule\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[default](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nunknown\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[head?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nContentModuleHead\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[headings?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n[ContentHeading](#contentheading)<!-- -->\\[\\]\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[onStaticGenerate?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n[StaticGenerateHandler](#staticgeneratehandler)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.pagemodule.md"
},
{
@@ -447,7 +447,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport declare type PathParams = Record<string, string>;\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.pathparams.md"
},
{
@@ -461,7 +461,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface QwikCityMockProps \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[goto?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[RouteNavigate](#routenavigate)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[params?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRecord&lt;string, string&gt;\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[url?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/qwik-city-component.tsx",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/qwik-city-component.tsx",
"mdFile": "qwik-city.qwikcitymockprops.md"
},
{
@@ -475,7 +475,7 @@
],
"kind": "Variable",
"content": "```typescript\nQwikCityMockProvider: import(\"@builder.io/qwik\").Component<QwikCityMockProps>\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/qwik-city-component.tsx",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/qwik-city-component.tsx",
"mdFile": "qwik-city.qwikcitymockprovider.md"
},
{
@@ -489,7 +489,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface QwikCityPlan \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[basePathname?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[cacheModules?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[menus?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n[MenuData](#menudata)<!-- -->\\[\\]\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[routes](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n[RouteData](#routedata)<!-- -->\\[\\]\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[serverPlugins?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nRouteModule\\[\\]\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[trailingSlash?](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.qwikcityplan.md"
},
{
@@ -503,7 +503,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface QwikCityProps \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[viewTransition?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Enable the ViewTransition API\n\nDefault: `true`\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/qwik-city-component.tsx",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/qwik-city-component.tsx",
"mdFile": "qwik-city.qwikcityprops.md"
},
{
@@ -517,7 +517,7 @@
],
"kind": "Variable",
"content": "```typescript\nQwikCityProvider: import(\"@builder.io/qwik\").Component<QwikCityProps>\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/qwik-city-component.tsx",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/qwik-city-component.tsx",
"mdFile": "qwik-city.qwikcityprovider.md"
},
{
@@ -531,7 +531,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type ResolvedDocumentHead<FrontMatter extends Record<string, any> = Record<string, unknown>> = Required<DocumentHeadValue<FrontMatter>>;\n```\n**References:** [DocumentHeadValue](#documentheadvalue)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.resolveddocumenthead.md"
},
{
@@ -545,7 +545,7 @@
],
"kind": "Variable",
"content": "```typescript\nrouteAction$: ActionConstructor\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"mdFile": "qwik-city.routeaction_.md"
},
{
@@ -559,7 +559,7 @@
],
"kind": "Variable",
"content": "```typescript\nrouteActionQrl: ActionConstructorQRL\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"mdFile": "qwik-city.routeactionqrl.md"
},
{
@@ -573,7 +573,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type RouteData = [routeName: string, loaders: ModuleLoader[]] | [\n routeName: string,\n loaders: ModuleLoader[],\n originalPathname: string,\n routeBundleNames: string[]\n];\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.routedata.md"
},
{
@@ -587,7 +587,7 @@
],
"kind": "Variable",
"content": "```typescript\nrouteLoader$: LoaderConstructor\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"mdFile": "qwik-city.routeloader_.md"
},
{
@@ -601,7 +601,7 @@
],
"kind": "Variable",
"content": "```typescript\nrouteLoaderQrl: LoaderConstructorQRL\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"mdFile": "qwik-city.routeloaderqrl.md"
},
{
@@ -615,7 +615,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface RouteLocation \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[isNavigating](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[params](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nReadonly&lt;Record&lt;string, string&gt;&gt;\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[prevUrl](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nURL \\| undefined\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[url](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nURL\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.routelocation.md"
},
{
@@ -629,7 +629,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type RouteNavigate = QRL<(path?: string, options?: {\n type?: Exclude<NavigationType, 'initial'>;\n forceReload?: boolean;\n replaceState?: boolean;\n scroll?: boolean;\n} | boolean) => Promise<void>>;\n```\n**References:** [NavigationType](#navigationtype)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.routenavigate.md"
},
{
@@ -643,7 +643,7 @@
],
"kind": "Variable",
"content": "```typescript\nRouterOutlet: import(\"@builder.io/qwik\").Component<unknown>\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/router-outlet-component.tsx",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/router-outlet-component.tsx",
"mdFile": "qwik-city.routeroutlet.md"
},
{
@@ -657,7 +657,7 @@
],
"kind": "Function",
"content": "```typescript\nserver$: <T extends ServerFunction>(first: T) => ServerQRL<T>\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nfirst\n\n\n</td><td>\n\nT\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\n[ServerQRL](#serverqrl)<!-- -->&lt;T&gt;",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"mdFile": "qwik-city.server_.md"
},
{
@@ -671,7 +671,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type ServerFunction = {\n (this: RequestEventBase, ...args: any[]): any;\n};\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.serverfunction.md"
},
{
@@ -685,7 +685,7 @@
],
"kind": "Function",
"content": "You can pass an AbortSignal as the first argument of a `server$` function and it will use it to abort the fetch when fired.\n\n\n```typescript\nexport type ServerQRL<T extends ServerFunction> = QRL<((abort: AbortSignal, ...args: Parameters<T>) => ReturnType<T>) | ((...args: Parameters<T>) => ReturnType<T>)>;\n```\n**References:** [ServerFunction](#serverfunction)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"mdFile": "qwik-city.serverqrl.md"
},
{
@@ -699,7 +699,7 @@
],
"kind": "TypeAlias",
"content": "You can pass an AbortSignal as the first argument of a `server$` function and it will use it to abort the fetch when fired.\n\n\n```typescript\nexport type ServerQRL<T extends ServerFunction> = QRL<((abort: AbortSignal, ...args: Parameters<T>) => ReturnType<T>) | ((...args: Parameters<T>) => ReturnType<T>)>;\n```\n**References:** [ServerFunction](#serverfunction)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.serverqrl.md"
},
{
@@ -713,7 +713,7 @@
],
"kind": "Function",
"content": "```typescript\nServiceWorkerRegister: (props: {\n nonce?: string;\n}) => import(\"@builder.io/qwik\").JSXNode<\"script\">\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nprops\n\n\n</td><td>\n\n{ nonce?: string; }\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nimport(\"@builder.io/qwik\").JSXNode&lt;\"script\"&gt;",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/sw-component.tsx",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/sw-component.tsx",
"mdFile": "qwik-city.serviceworkerregister.md"
},
{
@@ -727,7 +727,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface StaticGenerate \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[params?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[PathParams](#pathparams)<!-- -->\\[\\]\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.staticgenerate.md"
},
{
@@ -741,7 +741,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type StaticGenerateHandler = ({ env, }: {\n env: EnvGetter;\n}) => Promise<StaticGenerate> | StaticGenerate;\n```\n**References:** [StaticGenerate](#staticgenerate)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.staticgeneratehandler.md"
},
{
@@ -755,7 +755,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type StrictUnion<T> = Prettify<StrictUnionHelper<T, T>>;\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.strictunion.md"
},
{
@@ -769,7 +769,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type TypedDataValidator<T extends zod.ZodType = zod.ZodType> = {\n __zod: zod.ZodSchema<T>;\n validate(ev: RequestEvent, data: unknown): Promise<zod.SafeParseReturnType<T, T>>;\n};\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.typeddatavalidator.md"
},
{
@@ -783,7 +783,7 @@
],
"kind": "Function",
"content": "```typescript\nuseContent: () => import(\"./types\").ContentState\n```\n**Returns:**\n\nimport(\"./types\").ContentState",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/use-functions.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/use-functions.ts",
"mdFile": "qwik-city.usecontent.md"
},
{
@@ -797,7 +797,7 @@
],
"kind": "Function",
"content": "Returns the document head for the current page. The generic type describes the front matter.\n\n\n```typescript\nuseDocumentHead: <FrontMatter extends Record<string, unknown> = Record<string, any>>() => Required<Required<import(\"./types\").DocumentHeadValue<FrontMatter>>>\n```\n**Returns:**\n\nRequired&lt;Required&lt;import(\"./types\").[DocumentHeadValue](#documentheadvalue)<!-- -->&lt;FrontMatter&gt;&gt;&gt;",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/use-functions.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/use-functions.ts",
"mdFile": "qwik-city.usedocumenthead.md"
},
{
@@ -811,7 +811,7 @@
],
"kind": "Function",
"content": "```typescript\nuseLocation: () => RouteLocation\n```\n**Returns:**\n\n[RouteLocation](#routelocation)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/use-functions.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/use-functions.ts",
"mdFile": "qwik-city.uselocation.md"
},
{
@@ -825,7 +825,7 @@
],
"kind": "Function",
"content": "```typescript\nuseNavigate: () => RouteNavigate\n```\n**Returns:**\n\n[RouteNavigate](#routenavigate)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/use-functions.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/use-functions.ts",
"mdFile": "qwik-city.usenavigate.md"
},
{
@@ -839,7 +839,7 @@
],
"kind": "Variable",
"content": "```typescript\nvalidator$: ValidatorConstructor\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"mdFile": "qwik-city.validator_.md"
},
{
@@ -853,7 +853,7 @@
],
"kind": "Variable",
"content": "```typescript\nvalidatorQrl: ValidatorConstructorQRL\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"mdFile": "qwik-city.validatorqrl.md"
},
{
@@ -867,7 +867,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type ValidatorReturn<T extends Record<string, any> = {}> = ValidatorReturnSuccess | ValidatorReturnFail<T>;\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.validatorreturn.md"
},
{
@@ -881,7 +881,7 @@
],
"kind": "Variable",
"content": "```typescript\nzod$: ZodConstructor\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"mdFile": "qwik-city.zod_.md"
},
{
@@ -895,7 +895,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type ZodConstructor = {\n <T extends zod.ZodRawShape>(schema: T): TypedDataValidator<zod.ZodObject<T>>;\n <T extends zod.ZodRawShape>(schema: (z: typeof zod, ev: RequestEvent) => T): TypedDataValidator<zod.ZodObject<T>>;\n <T extends zod.Schema>(schema: T): TypedDataValidator<T>;\n <T extends zod.Schema>(schema: (z: typeof zod, ev: RequestEvent) => T): TypedDataValidator<T>;\n};\n```\n**References:** [TypedDataValidator](#typeddatavalidator)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts",
"mdFile": "qwik-city.zodconstructor.md"
},
{
@@ -909,7 +909,7 @@
],
"kind": "Variable",
"content": "```typescript\nzodQrl: ZodConstructorQRL\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts",
"mdFile": "qwik-city.zodqrl.md"
}
]

130
packages/docs/src/routes/api/qwik-city/index.md
View File

@@ -18,7 +18,7 @@ export type Action<
**References:** [ActionStore](#actionstore)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## ActionConstructor
@@ -138,7 +138,7 @@ export type ActionConstructor = {
**References:** [TypedDataValidator](#typeddatavalidator), [DataValidator](#datavalidator), [GetValidatorType](#getvalidatortype), [Action](#action), [StrictUnion](#strictunion), [FailReturn](#failreturn), [FailOfRest](#failofrest), [JSONObject](#jsonobject)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## ActionReturn
@@ -149,7 +149,7 @@ export type ActionReturn<RETURN> = {
};
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## ActionStore
@@ -170,7 +170,7 @@ export type ActionStore<RETURN, INPUT, OPTIONAL extends boolean = true> = {
**References:** [ActionReturn](#actionreturn)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## ContentHeading
@@ -242,7 +242,7 @@ string
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## ContentMenu
@@ -318,7 +318,7 @@ string
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## DataValidator
@@ -330,7 +330,7 @@ export type DataValidator<T extends Record<string, any> = {}> = {
**References:** [ValidatorReturn](#validatorreturn)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## DocumentHead
@@ -342,7 +342,7 @@ export type DocumentHead =
**References:** [DocumentHeadValue](#documentheadvalue), [DocumentHeadProps](#documentheadprops)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## DocumentHeadProps
@@ -416,7 +416,7 @@ ResolveSyncValue
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## DocumentHeadValue
@@ -545,7 +545,7 @@ _(Optional)_ Sets `document.title`.
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## DocumentLink
@@ -827,7 +827,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## DocumentMeta
@@ -973,7 +973,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## DocumentScript
@@ -1053,7 +1053,7 @@ string
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## DocumentStyle
@@ -1129,7 +1129,7 @@ string
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## FailOfRest
@@ -1140,7 +1140,7 @@ export type FailOfRest<REST extends readonly DataValidator[]> =
**References:** [DataValidator](#datavalidator)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## FailReturn
@@ -1148,7 +1148,7 @@ export type FailOfRest<REST extends readonly DataValidator[]> =
export type FailReturn<T> = T & Failed;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## Form
@@ -1199,7 +1199,7 @@ string \| null
import("@builder.io/qwik").JSXOutput
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/form-component.tsx)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/form-component.tsx)
## FormProps
@@ -1320,7 +1320,7 @@ Defaults to `false`
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/form-component.tsx)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/form-component.tsx)
## FormSubmitSuccessDetail
@@ -1373,7 +1373,7 @@ T
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/form-component.tsx)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/form-component.tsx)
## GetValidatorType
@@ -1384,7 +1384,7 @@ export type GetValidatorType<VALIDATOR extends TypedDataValidator> =
**References:** [TypedDataValidator](#typeddatavalidator)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## globalAction$
@@ -1392,7 +1392,7 @@ export type GetValidatorType<VALIDATOR extends TypedDataValidator> =
globalAction$: ActionConstructor;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
## globalActionQrl
@@ -1400,7 +1400,7 @@ globalAction$: ActionConstructor;
globalActionQrl: ActionConstructorQRL;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
## JSONObject
@@ -1412,7 +1412,7 @@ export type JSONObject = {
**References:** [JSONValue](#jsonvalue)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## JSONValue
@@ -1429,7 +1429,7 @@ export type JSONValue =
**References:** [JSONValue](#jsonvalue)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## Link
@@ -1437,7 +1437,7 @@ export type JSONValue =
Link: import("@builder.io/qwik").Component<LinkProps>;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/link-component.tsx)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/link-component.tsx)
## LinkProps
@@ -1536,7 +1536,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/link-component.tsx)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/link-component.tsx)
## Loader_2
@@ -1548,7 +1548,7 @@ export type Loader<RETURN> = {
**References:** [LoaderSignal](#loadersignal)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## LoaderSignal
@@ -1560,7 +1560,7 @@ export type LoaderSignal<TYPE> = TYPE extends () => ValueOrPromise<
: ReadonlySignal<TYPE>;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## MenuData
@@ -1568,7 +1568,7 @@ export type LoaderSignal<TYPE> = TYPE extends () => ValueOrPromise<
export type MenuData = [pathname: string, menuLoader: MenuModuleLoader];
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## NavigationType
@@ -1576,7 +1576,7 @@ export type MenuData = [pathname: string, menuLoader: MenuModuleLoader];
export type NavigationType = "initial" | "form" | "link" | "popstate";
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## PageModule
@@ -1671,7 +1671,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## PathParams
@@ -1679,7 +1679,7 @@ _(Optional)_
export declare type PathParams = Record<string, string>;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## QwikCityMockProps
@@ -1751,7 +1751,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/qwik-city-component.tsx)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/qwik-city-component.tsx)
## QwikCityMockProvider
@@ -1759,7 +1759,7 @@ _(Optional)_
QwikCityMockProvider: import("@builder.io/qwik").Component<QwikCityMockProps>;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/qwik-city-component.tsx)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/qwik-city-component.tsx)
## QwikCityPlan
@@ -1886,7 +1886,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## QwikCityProps
@@ -1930,7 +1930,7 @@ Default: `true`
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/qwik-city-component.tsx)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/qwik-city-component.tsx)
## QwikCityProvider
@@ -1938,7 +1938,7 @@ Default: `true`
QwikCityProvider: import("@builder.io/qwik").Component<QwikCityProps>;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/qwik-city-component.tsx)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/qwik-city-component.tsx)
## ResolvedDocumentHead
@@ -1950,7 +1950,7 @@ export type ResolvedDocumentHead<
**References:** [DocumentHeadValue](#documentheadvalue)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## routeAction$
@@ -1958,7 +1958,7 @@ export type ResolvedDocumentHead<
routeAction$: ActionConstructor;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
## routeActionQrl
@@ -1966,7 +1966,7 @@ routeAction$: ActionConstructor;
routeActionQrl: ActionConstructorQRL;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
## RouteData
@@ -1981,7 +1981,7 @@ export type RouteData =
];
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## routeLoader$
@@ -1989,7 +1989,7 @@ export type RouteData =
routeLoader$: LoaderConstructor;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
## routeLoaderQrl
@@ -1997,7 +1997,7 @@ routeLoader$: LoaderConstructor;
routeLoaderQrl: LoaderConstructorQRL;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
## RouteLocation
@@ -2084,7 +2084,7 @@ URL
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## RouteNavigate
@@ -2106,7 +2106,7 @@ export type RouteNavigate = QRL<
**References:** [NavigationType](#navigationtype)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## RouterOutlet
@@ -2114,7 +2114,7 @@ export type RouteNavigate = QRL<
RouterOutlet: import("@builder.io/qwik").Component<unknown>;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/router-outlet-component.tsx)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/router-outlet-component.tsx)
## server$
@@ -2151,7 +2151,7 @@ T
[ServerQRL](#serverqrl)&lt;T&gt;
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
## ServerFunction
@@ -2161,7 +2161,7 @@ export type ServerFunction = {
};
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## serverQrl
@@ -2176,7 +2176,7 @@ export type ServerQRL<T extends ServerFunction> = QRL<
**References:** [ServerFunction](#serverfunction)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
## ServerQRL
@@ -2191,7 +2191,7 @@ export type ServerQRL<T extends ServerFunction> = QRL<
**References:** [ServerFunction](#serverfunction)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## ServiceWorkerRegister
@@ -2229,7 +2229,7 @@ props
import("@builder.io/qwik").JSXNode&lt;"script"&gt;
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/sw-component.tsx)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/sw-component.tsx)
## StaticGenerate
@@ -2271,7 +2271,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## StaticGenerateHandler
@@ -2285,7 +2285,7 @@ export type StaticGenerateHandler = ({
**References:** [StaticGenerate](#staticgenerate)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## StrictUnion
@@ -2293,7 +2293,7 @@ export type StaticGenerateHandler = ({
export type StrictUnion<T> = Prettify<StrictUnionHelper<T, T>>;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## TypedDataValidator
@@ -2307,7 +2307,7 @@ export type TypedDataValidator<T extends zod.ZodType = zod.ZodType> = {
};
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## useContent
@@ -2319,7 +2319,7 @@ useContent: () => import("./types").ContentState;
import("./types").ContentState
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/use-functions.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/use-functions.ts)
## useDocumentHead
@@ -2335,7 +2335,7 @@ useDocumentHead: <
Required&lt;Required&lt;import("./types").[DocumentHeadValue](#documentheadvalue)&lt;FrontMatter&gt;&gt;&gt;
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/use-functions.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/use-functions.ts)
## useLocation
@@ -2347,7 +2347,7 @@ useLocation: () => RouteLocation;
[RouteLocation](#routelocation)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/use-functions.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/use-functions.ts)
## useNavigate
@@ -2359,7 +2359,7 @@ useNavigate: () => RouteNavigate;
[RouteNavigate](#routenavigate)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/use-functions.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/use-functions.ts)
## validator$
@@ -2367,7 +2367,7 @@ useNavigate: () => RouteNavigate;
validator$: ValidatorConstructor;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
## validatorQrl
@@ -2375,7 +2375,7 @@ validator$: ValidatorConstructor;
validatorQrl: ValidatorConstructorQRL;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
## ValidatorReturn
@@ -2385,7 +2385,7 @@ export type ValidatorReturn<T extends Record<string, any> = {}> =
| ValidatorReturnFail<T>;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## zod$
@@ -2393,7 +2393,7 @@ export type ValidatorReturn<T extends Record<string, any> = {}> =
zod$: ZodConstructor;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
## ZodConstructor
@@ -2412,7 +2412,7 @@ export type ZodConstructor = {
**References:** [TypedDataValidator](#typeddatavalidator)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/types.ts)
## zodQrl
@@ -2420,4 +2420,4 @@ export type ZodConstructor = {
zodQrl: ZodConstructorQRL;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/runtime/src/server-functions.ts)

86
packages/docs/src/routes/api/qwik-optimizer/api.json
View File

@@ -30,7 +30,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface ComponentEntryStrategy \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[manual?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRecord&lt;string, string&gt;\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[type](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'component'\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.componententrystrategy.md"
},
{
@@ -44,7 +44,7 @@
],
"kind": "Function",
"content": "```typescript\ncreateOptimizer: (optimizerOptions?: OptimizerOptions) => Promise<Optimizer>\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\noptimizerOptions\n\n\n</td><td>\n\n[OptimizerOptions](#optimizeroptions)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nPromise&lt;[Optimizer](#optimizer)<!-- -->&gt;",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/optimizer.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/optimizer.ts",
"mdFile": "qwik.createoptimizer.md"
},
{
@@ -58,7 +58,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface Diagnostic \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[category](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[DiagnosticCategory](#diagnosticcategory)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[code](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring \\| null\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[file](#)\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[highlights](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[SourceLocation](#sourcelocation)<!-- -->\\[\\]\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[message](#)\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[scope](#)\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[suggestions](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\\[\\] \\| null\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.diagnostic.md"
},
{
@@ -72,7 +72,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type DiagnosticCategory = 'error' | 'warning' | 'sourceError';\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.diagnosticcategory.md"
},
{
@@ -103,7 +103,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type EntryStrategy = InlineEntryStrategy | HoistEntryStrategy | SingleEntryStrategy | HookEntryStrategy | ComponentEntryStrategy | SmartEntryStrategy;\n```\n**References:** [InlineEntryStrategy](#inlineentrystrategy)<!-- -->, [SingleEntryStrategy](#singleentrystrategy)<!-- -->, [HookEntryStrategy](#hookentrystrategy)<!-- -->, [ComponentEntryStrategy](#componententrystrategy)<!-- -->, [SmartEntryStrategy](#smartentrystrategy)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.entrystrategy.md"
},
{
@@ -151,7 +151,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface GlobalInjections \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[attributes?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n{ \\[key: string\\]: string; }\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[location](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'head' \\| 'body'\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[tag](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.globalinjections.md"
},
{
@@ -165,7 +165,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface HookAnalysis \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[canonicalFilename](#)\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[captures](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[ctxKind](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'event' \\| 'function'\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[ctxName](#)\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[displayName](#)\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[entry](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring \\| null\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[extension](#)\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[hash](#)\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[loc](#)\n\n\n</td><td>\n\n\n</td><td>\n\n\\[number, number\\]\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[name](#)\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[origin](#)\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[parent](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring \\| null\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.hookanalysis.md"
},
{
@@ -179,7 +179,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface HookEntryStrategy \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[manual?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRecord&lt;string, string&gt;\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[type](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'hook'\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.hookentrystrategy.md"
},
{
@@ -193,7 +193,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface InlineEntryStrategy \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[type](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'inline'\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.inlineentrystrategy.md"
},
{
@@ -207,7 +207,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface InsightManifest \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[manual](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRecord&lt;string, string&gt;\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[prefetch](#)\n\n\n</td><td>\n\n\n</td><td>\n\n{ route: string; symbols: string\\[\\]; }\\[\\]\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[type](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'smart'\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.insightmanifest.md"
},
{
@@ -255,7 +255,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type MinifyMode = 'simplify' | 'none';\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.minifymode.md"
},
{
@@ -286,7 +286,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface Optimizer \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[sys](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[OptimizerSystem](#optimizersystem)\n\n\n</td><td>\n\nOptimizer system use. This can be updated with a custom file system.\n\n\n</td></tr>\n</tbody></table>\n\n\n<table><thead><tr><th>\n\nMethod\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[transformFs(opts)](#optimizer-transformfs)\n\n\n</td><td>\n\nTransforms the directory from the file system.\n\n\n</td></tr>\n<tr><td>\n\n[transformFsSync(opts)](#optimizer-transformfssync)\n\n\n</td><td>\n\nTransforms the directory from the file system.\n\n\n</td></tr>\n<tr><td>\n\n[transformModules(opts)](#optimizer-transformmodules)\n\n\n</td><td>\n\nTransforms the input code string, does not access the file system.\n\n\n</td></tr>\n<tr><td>\n\n[transformModulesSync(opts)](#optimizer-transformmodulessync)\n\n\n</td><td>\n\nTransforms the input code string, does not access the file system.\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.optimizer.md"
},
{
@@ -300,7 +300,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface OptimizerOptions \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[binding?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nany\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[inlineStylesUpToBytes?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n_(Optional)_ Inline the global styles if they're smaller than this\n\n\n</td></tr>\n<tr><td>\n\n[sourcemap?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Enable sourcemaps\n\n\n</td></tr>\n<tr><td>\n\n[sys?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[OptimizerSystem](#optimizersystem)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.optimizeroptions.md"
},
{
@@ -314,7 +314,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface OptimizerSystem \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[cwd](#)\n\n\n</td><td>\n\n\n</td><td>\n\n() =&gt; string\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[dynamicImport](#)\n\n\n</td><td>\n\n\n</td><td>\n\n(path: string) =&gt; Promise&lt;any&gt;\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[env](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[SystemEnvironment](#systemenvironment)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[getInputFiles?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n(rootDir: string) =&gt; Promise&lt;[TransformModuleInput](#transformmoduleinput)<!-- -->\\[\\]&gt;\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[os](#)\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[path](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[Path](#path)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[strictDynamicImport](#)\n\n\n</td><td>\n\n\n</td><td>\n\n(path: string) =&gt; Promise&lt;any&gt;\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.optimizersystem.md"
},
{
@@ -345,7 +345,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface Path \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[delimiter](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[posix](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\n[Path](#path)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[sep](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[win32](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nnull\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n\n\n<table><thead><tr><th>\n\nMethod\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[basename(path, ext)](#path-basename)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[dirname(path)](#path-dirname)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[extname(path)](#path-extname)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[format(pathObject)](#path-format)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[isAbsolute(path)](#path-isabsolute)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[join(paths)](#path-join)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[normalize(path)](#path-normalize)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[parse(path)](#path-parse)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[relative(from, to)](#path-relative)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[resolve(paths)](#path-resolve)\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.path.md"
},
{
@@ -359,7 +359,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type QwikBuildMode = 'production' | 'development';\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/plugin.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/plugin.ts",
"mdFile": "qwik.qwikbuildmode.md"
},
{
@@ -373,7 +373,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type QwikBuildTarget = 'client' | 'ssr' | 'lib' | 'test';\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/plugin.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/plugin.ts",
"mdFile": "qwik.qwikbuildtarget.md"
},
{
@@ -387,7 +387,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface QwikBundle \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[dynamicImports?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\\[\\]\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[imports?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\\[\\]\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[origins?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\\[\\]\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[size](#)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[symbols?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\\[\\]\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.qwikbundle.md"
},
{
@@ -401,7 +401,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface QwikManifest \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[bundles](#)\n\n\n</td><td>\n\n\n</td><td>\n\n{ \\[fileName: string\\]: [QwikBundle](#qwikbundle)<!-- -->; }\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[injections?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[GlobalInjections](#globalinjections)<!-- -->\\[\\]\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[manifestHash](#)\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[mapping](#)\n\n\n</td><td>\n\n\n</td><td>\n\n{ \\[symbolName: string\\]: string; }\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[options?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n{ target?: string; buildMode?: string; entryStrategy?: { \\[key: string\\]: any; }; }\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[platform?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n{ \\[name: string\\]: string; }\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[symbols](#)\n\n\n</td><td>\n\n\n</td><td>\n\n{ \\[symbolName: string\\]: [QwikSymbol](#qwiksymbol)<!-- -->; }\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[version](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.qwikmanifest.md"
},
{
@@ -415,7 +415,7 @@
],
"kind": "Function",
"content": "```typescript\nexport declare function qwikRollup(qwikRollupOpts?: QwikRollupPluginOptions): any;\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nqwikRollupOpts\n\n\n</td><td>\n\n[QwikRollupPluginOptions](#qwikrolluppluginoptions)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nany",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/rollup.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/rollup.ts",
"mdFile": "qwik.qwikrollup.md"
},
{
@@ -429,7 +429,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface QwikRollupPluginOptions \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[buildMode?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[QwikBuildMode](#qwikbuildmode)\n\n\n</td><td>\n\n_(Optional)_ Build `production` or `development`<!-- -->.\n\nDefault `development`\n\n\n</td></tr>\n<tr><td>\n\n[csr?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[debug?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Prints verbose Qwik plugin debug logs.\n\nDefault `false`\n\n\n</td></tr>\n<tr><td>\n\n[entryStrategy?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[EntryStrategy](#entrystrategy)\n\n\n</td><td>\n\n_(Optional)_ The Qwik entry strategy to use while building for production. During development the type is always `hook`<!-- -->.\n\nDefault `{ type: \"smart\" }`<!-- -->)\n\n\n</td></tr>\n<tr><td>\n\n[lint?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Run eslint on the source files for the ssr build or dev server. This can slow down startup on large projects. Defaults to `true`\n\n\n</td></tr>\n<tr><td>\n\n[manifestInput?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[QwikManifest](#qwikmanifest)\n\n\n</td><td>\n\n_(Optional)_ The SSR build requires the manifest generated during the client build. The `manifestInput` option can be used to manually provide a manifest.\n\nDefault `undefined`\n\n\n</td></tr>\n<tr><td>\n\n[manifestOutput?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n(manifest: [QwikManifest](#qwikmanifest)<!-- -->) =&gt; Promise&lt;void&gt; \\| void\n\n\n</td><td>\n\n_(Optional)_ The client build will create a manifest and this hook is called with the generated build data.\n\nDefault `undefined`\n\n\n</td></tr>\n<tr><td>\n\n[optimizerOptions?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[OptimizerOptions](#optimizeroptions)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[rootDir?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_ The root of the application, which is commonly the same directory as `package.json` and `rollup.config.js`<!-- -->.\n\nDefault `process.cwd()`\n\n\n</td></tr>\n<tr><td>\n\n[srcDir?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_ The source directory to find all the Qwik components. Since Qwik does not have a single input, the `srcDir` is used to recursively find Qwik files.\n\nDefault `src`\n\n\n</td></tr>\n<tr><td>\n\n[srcInputs?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[TransformModuleInput](#transformmoduleinput)<!-- -->\\[\\] \\| null\n\n\n</td><td>\n\n_(Optional)_ Alternative to `srcDir`<!-- -->, where `srcInputs` is able to provide the files manually. This option is useful for an environment without a file system, such as a webworker.\n\nDefault: `null`\n\n\n</td></tr>\n<tr><td>\n\n[target?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[QwikBuildTarget](#qwikbuildtarget)\n\n\n</td><td>\n\n_(Optional)_ Target `client` or `ssr`<!-- -->.\n\nDefault `client`\n\n\n</td></tr>\n<tr><td>\n\n[transformedModuleOutput?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n((transformedModules: [TransformModule](#transformmodule)<!-- -->\\[\\]) =&gt; Promise&lt;void&gt; \\| void) \\| null\n\n\n</td><td>\n\n_(Optional)_ Hook that's called after the build and provides all of the transformed modules that were used before bundling.\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/rollup.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/rollup.ts",
"mdFile": "qwik.qwikrolluppluginoptions.md"
},
{
@@ -443,7 +443,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface QwikSymbol \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[canonicalFilename](#)\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[captures](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[ctxKind](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'function' \\| 'event'\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[ctxName](#)\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[displayName](#)\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[hash](#)\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[loc](#)\n\n\n</td><td>\n\n\n</td><td>\n\n\\[number, number\\]\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[origin](#)\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[parent](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring \\| null\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.qwiksymbol.md"
},
{
@@ -457,7 +457,7 @@
],
"kind": "Function",
"content": "```typescript\nexport declare function qwikVite(qwikViteOpts?: QwikVitePluginOptions): any;\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nqwikViteOpts\n\n\n</td><td>\n\n[QwikVitePluginOptions](#qwikvitepluginoptions)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nany",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/vite.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/vite.ts",
"mdFile": "qwik.qwikvite.md"
},
{
@@ -471,7 +471,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface QwikViteDevResponse \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[\\_qwikEnvData?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRecord&lt;string, any&gt;\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[\\_qwikRenderResolve?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n() =&gt; void\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/vite.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/vite.ts",
"mdFile": "qwik.qwikvitedevresponse.md"
},
{
@@ -485,7 +485,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface QwikVitePlugin \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[api](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[QwikVitePluginApi](#qwikvitepluginapi)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[name](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'vite-plugin-qwik'\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/vite.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/vite.ts",
"mdFile": "qwik.qwikviteplugin.md"
},
{
@@ -499,7 +499,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface QwikVitePluginApi \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[getClientOutDir](#)\n\n\n</td><td>\n\n\n</td><td>\n\n() =&gt; string \\| null\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[getClientPublicOutDir](#)\n\n\n</td><td>\n\n\n</td><td>\n\n() =&gt; string \\| null\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[getInsightsManifest](#)\n\n\n</td><td>\n\n\n</td><td>\n\n(clientOutDir?: string \\| null) =&gt; Promise&lt;[InsightManifest](#insightmanifest) \\| null&gt;\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[getManifest](#)\n\n\n</td><td>\n\n\n</td><td>\n\n() =&gt; [QwikManifest](#qwikmanifest) \\| null\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[getOptimizer](#)\n\n\n</td><td>\n\n\n</td><td>\n\n() =&gt; [Optimizer](#optimizer) \\| null\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[getOptions](#)\n\n\n</td><td>\n\n\n</td><td>\n\n() =&gt; NormalizedQwikPluginOptions\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[getRootDir](#)\n\n\n</td><td>\n\n\n</td><td>\n\n() =&gt; string \\| null\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/vite.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/vite.ts",
"mdFile": "qwik.qwikvitepluginapi.md"
},
{
@@ -513,7 +513,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type QwikVitePluginOptions = QwikVitePluginCSROptions | QwikVitePluginSSROptions;\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/vite.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/vite.ts",
"mdFile": "qwik.qwikvitepluginoptions.md"
},
{
@@ -561,7 +561,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface ResolvedManifest \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[manifest](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[QwikManifest](#qwikmanifest)\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[mapper](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[SymbolMapper](#symbolmapper)\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.resolvedmanifest.md"
},
{
@@ -575,7 +575,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface SingleEntryStrategy \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[manual?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRecord&lt;string, string&gt;\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[type](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'single'\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.singleentrystrategy.md"
},
{
@@ -589,7 +589,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface SmartEntryStrategy \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[manual?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRecord&lt;string, string&gt;\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[type](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'smart'\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.smartentrystrategy.md"
},
{
@@ -603,7 +603,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface SourceLocation \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[endCol](#)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[endLine](#)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[hi](#)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[lo](#)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[startCol](#)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[startLine](#)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.sourcelocation.md"
},
{
@@ -617,7 +617,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type SourceMapsOption = 'external' | 'inline' | undefined | null;\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.sourcemapsoption.md"
},
{
@@ -631,7 +631,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type SymbolMapper = Record<string, readonly [symbol: string, chunk: string]>;\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.symbolmapper.md"
},
{
@@ -645,7 +645,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type SymbolMapperFn = (symbolName: string, mapper: SymbolMapper | undefined) => readonly [symbol: string, chunk: string] | undefined;\n```\n**References:** [SymbolMapper](#symbolmapper)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.symbolmapperfn.md"
},
{
@@ -659,7 +659,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type SystemEnvironment = 'node' | 'deno' | 'bun' | 'webworker' | 'browsermain' | 'unknown';\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.systemenvironment.md"
},
{
@@ -690,7 +690,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface TransformFsOptions extends TransformOptions \n```\n**Extends:** [TransformOptions](#transformoptions)\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[vendorRoots](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\\[\\]\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.transformfsoptions.md"
},
{
@@ -721,7 +721,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface TransformModule \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[code](#)\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[hook](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[HookAnalysis](#hookanalysis) \\| null\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[isEntry](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[map](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring \\| null\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[origPath](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring \\| null\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[path](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.transformmodule.md"
},
{
@@ -735,7 +735,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface TransformModuleInput \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[code](#)\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[path](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.transformmoduleinput.md"
},
{
@@ -766,7 +766,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface TransformModulesOptions extends TransformOptions \n```\n**Extends:** [TransformOptions](#transformoptions)\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[input](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[TransformModuleInput](#transformmoduleinput)<!-- -->\\[\\]\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.transformmodulesoptions.md"
},
{
@@ -797,7 +797,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface TransformOptions \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[entryStrategy?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[EntryStrategy](#entrystrategy)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[explicitExtensions?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[isServer?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[minify?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[MinifyMode](#minifymode)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[mode?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nEmitMode\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[preserveFilenames?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[regCtxName?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\\[\\]\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[rootDir?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[scope?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[sourceMaps?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[srcDir](#)\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[stripCtxName?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\\[\\]\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[stripEventHandlers?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[stripExports?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\\[\\]\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[transpileJsx?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[transpileTs?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.transformoptions.md"
},
{
@@ -811,7 +811,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface TransformOutput \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[diagnostics](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[Diagnostic](#diagnostic)<!-- -->\\[\\]\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[isJsx](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[isTypeScript](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[modules](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[TransformModule](#transformmodule)<!-- -->\\[\\]\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.transformoutput.md"
},
{
@@ -825,7 +825,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type TranspileOption = boolean | undefined | null;\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts",
"mdFile": "qwik.transpileoption.md"
},
{
@@ -839,7 +839,7 @@
],
"kind": "Variable",
"content": "```typescript\nversions: {\n qwik: string;\n}\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/versions.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/versions.ts",
"mdFile": "qwik.versions.md"
}
]

86
packages/docs/src/routes/api/qwik-optimizer/index.md
View File

@@ -105,7 +105,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## createOptimizer
@@ -144,7 +144,7 @@ _(Optional)_
Promise&lt;[Optimizer](#optimizer)&gt;
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/optimizer.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/optimizer.ts)
## Diagnostic
@@ -262,7 +262,7 @@ string[] \| null
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## DiagnosticCategory
@@ -270,7 +270,7 @@ string[] \| null
export type DiagnosticCategory = "error" | "warning" | "sourceError";
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## dirname
@@ -321,7 +321,7 @@ export type EntryStrategy =
**References:** [InlineEntryStrategy](#inlineentrystrategy), [SingleEntryStrategy](#singleentrystrategy), [HookEntryStrategy](#hookentrystrategy), [ComponentEntryStrategy](#componententrystrategy), [SmartEntryStrategy](#smartentrystrategy)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## extname
@@ -465,7 +465,7 @@ string
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## HookAnalysis
@@ -648,7 +648,7 @@ string \| null
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## HookEntryStrategy
@@ -703,7 +703,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## InlineEntryStrategy
@@ -743,7 +743,7 @@ Description
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## InsightManifest
@@ -809,7 +809,7 @@ Record&lt;string, string&gt;
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## isAbsolute
@@ -887,7 +887,7 @@ string
export type MinifyMode = "simplify" | "none";
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## normalize
@@ -1011,7 +1011,7 @@ Transforms the input code string, does not access the file system.
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## OptimizerOptions
@@ -1098,7 +1098,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## OptimizerSystem
@@ -1218,7 +1218,7 @@ string
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## parse
@@ -1427,7 +1427,7 @@ Description
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## QwikBuildMode
@@ -1435,7 +1435,7 @@ Description
export type QwikBuildMode = "production" | "development";
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/plugin.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/plugin.ts)
## QwikBuildTarget
@@ -1443,7 +1443,7 @@ export type QwikBuildMode = "production" | "development";
export type QwikBuildTarget = "client" | "ssr" | "lib" | "test";
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/plugin.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/plugin.ts)
## QwikBundle
@@ -1543,7 +1543,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## QwikManifest
@@ -1680,7 +1680,7 @@ string
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## qwikRollup
@@ -1721,7 +1721,7 @@ _(Optional)_
any
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/rollup.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/rollup.ts)
## QwikRollupPluginOptions
@@ -1961,7 +1961,7 @@ _(Optional)_ Hook that's called after the build and provides all of the transfor
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/rollup.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/rollup.ts)
## QwikSymbol
@@ -2105,7 +2105,7 @@ string \| null
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## qwikVite
@@ -2144,7 +2144,7 @@ _(Optional)_
any
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/vite.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/vite.ts)
## QwikViteDevResponse
@@ -2201,7 +2201,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/vite.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/vite.ts)
## QwikVitePlugin
@@ -2254,7 +2254,7 @@ Description
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/vite.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/vite.ts)
## QwikVitePluginApi
@@ -2372,7 +2372,7 @@ Description
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/vite.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/vite.ts)
## QwikVitePluginOptions
@@ -2382,7 +2382,7 @@ export type QwikVitePluginOptions =
| QwikVitePluginSSROptions;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/vite.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/plugins/vite.ts)
## relative
@@ -2516,7 +2516,7 @@ Description
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## SingleEntryStrategy
@@ -2571,7 +2571,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## SmartEntryStrategy
@@ -2626,7 +2626,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## SourceLocation
@@ -2731,7 +2731,7 @@ number
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## SourceMapsOption
@@ -2739,7 +2739,7 @@ number
export type SourceMapsOption = "external" | "inline" | undefined | null;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## SymbolMapper
@@ -2750,7 +2750,7 @@ export type SymbolMapper = Record<
>;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## SymbolMapperFn
@@ -2763,7 +2763,7 @@ export type SymbolMapperFn = (
**References:** [SymbolMapper](#symbolmapper)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## SystemEnvironment
@@ -2777,7 +2777,7 @@ export type SystemEnvironment =
| "unknown";
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## transformFs
@@ -2856,7 +2856,7 @@ string[]
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## transformFsSync
@@ -2998,7 +2998,7 @@ string
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## TransformModuleInput
@@ -3051,7 +3051,7 @@ string
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## transformModules
@@ -3130,7 +3130,7 @@ Description
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## transformModulesSync
@@ -3432,7 +3432,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## TransformOutput
@@ -3511,7 +3511,7 @@ boolean
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## TranspileOption
@@ -3519,7 +3519,7 @@ boolean
export type TranspileOption = boolean | undefined | null;
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/types.ts)
## versions
@@ -3529,4 +3529,4 @@ versions: {
}
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/optimizer/src/versions.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/optimizer/src/versions.ts)

52
packages/docs/src/routes/api/qwik-server/api.json
View File

@@ -13,7 +13,7 @@
],
"kind": "Function",
"content": "Provides the `qwikloader.js` file as a string. Useful for tooling to inline the qwikloader script into HTML.\n\n\n```typescript\nexport declare function getQwikLoaderScript(opts?: {\n debug?: boolean;\n}): string;\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nopts\n\n\n</td><td>\n\n{ debug?: boolean; }\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nstring",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/scripts.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/scripts.ts",
"mdFile": "qwik.getqwikloaderscript.md"
},
{
@@ -27,7 +27,7 @@
],
"kind": "Function",
"content": "Provides the `qwik-prefetch-service-worker.js` file as a string. Useful for tooling to inline the qwikloader script into HTML.\n\n\n```typescript\nexport declare function getQwikPrefetchWorkerScript(opts?: {\n debug?: boolean;\n}): string;\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nopts\n\n\n</td><td>\n\n{ debug?: boolean; }\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nstring",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/scripts.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/scripts.ts",
"mdFile": "qwik.getqwikprefetchworkerscript.md"
},
{
@@ -41,7 +41,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>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.inorderauto.md"
},
{
@@ -55,7 +55,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface InOrderDisabled \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[strategy](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'disabled'\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.inorderdisabled.md"
},
{
@@ -69,7 +69,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type InOrderStreaming = InOrderAuto | InOrderDisabled | InOrderDirect;\n```\n**References:** [InOrderAuto](#inorderauto)<!-- -->, [InOrderDisabled](#inorderdisabled)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.inorderstreaming.md"
},
{
@@ -83,7 +83,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface PrefetchImplementation \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[linkInsert?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'js-append' \\| 'html-append' \\| null\n\n\n</td><td>\n\n_(Optional)_ `js-append`<!-- -->: Use JS runtime to create each `<link>` and append to the body.\n\n`html-append`<!-- -->: Render each `<link>` within html, appended at the end of the body.\n\n\n</td></tr>\n<tr><td>\n\n[linkRel?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'prefetch' \\| 'preload' \\| 'modulepreload' \\| null\n\n\n</td><td>\n\n_(Optional)_ Value of the `<link rel=\"...\">` attribute when link is used. Defaults to `prefetch` if links are inserted.\n\n\n</td></tr>\n<tr><td>\n\n[prefetchEvent?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'always' \\| null\n\n\n</td><td>\n\n_(Optional)_ Dispatch a `qprefetch` event with detail data containing the bundles that should be prefetched. The event dispatch script will be inlined into the document's HTML so any listeners of this event should already be ready to handle the event.\n\nThis implementation will inject a script similar to:\n\n```\n<script type=\"module\">\n document.dispatchEvent(new CustomEvent(\"qprefetch\", { detail:{ \"bundles\": [...] } }))\n</script>\n```\nBy default, the `prefetchEvent` implementation will be set to `always`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[workerFetchInsert?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'always' \\| 'no-link-support' \\| null\n\n\n</td><td>\n\n_(Optional)_ `always`<!-- -->: Always include the worker fetch JS runtime.\n\n`no-link-support`<!-- -->: Only include the worker fetch JS runtime when the browser doesn't support `<link>` prefetch/preload/modulepreload.\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.prefetchimplementation.md"
},
{
@@ -97,7 +97,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface PrefetchResource \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[imports](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[PrefetchResource](#prefetchresource)<!-- -->\\[\\]\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[url](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.prefetchresource.md"
},
{
@@ -111,7 +111,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface PrefetchStrategy \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[implementation?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[PrefetchImplementation](#prefetchimplementation)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[symbolsToPrefetch?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[SymbolsToPrefetch](#symbolstoprefetch)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.prefetchstrategy.md"
},
{
@@ -125,7 +125,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface QwikLoaderOptions \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[include?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'always' \\| 'never' \\| 'auto'\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[position?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n'top' \\| 'bottom'\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.qwikloaderoptions.md"
},
{
@@ -139,7 +139,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type Render = RenderToString | RenderToStream;\n```\n**References:** [RenderToString](#rendertostring)<!-- -->, [RenderToStream](#rendertostream)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.render.md"
},
{
@@ -153,7 +153,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface RenderOptions extends SerializeDocumentOptions \n```\n**Extends:** [SerializeDocumentOptions](#serializedocumentoptions)\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[base?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring \\| ((options: [RenderOptions](#renderoptions)<!-- -->) =&gt; string)\n\n\n</td><td>\n\n_(Optional)_ Specifies the root of the JS files of the client build. Setting a base, will cause the render of the `q:base` attribute in the `q:container` element.\n\n\n</td></tr>\n<tr><td>\n\n[containerAttributes?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRecord&lt;string, string&gt;\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[containerTagName?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring\n\n\n</td><td>\n\n_(Optional)_ When set, the app is serialized into a fragment. And the returned html is not a complete document. Defaults to `html`\n\n\n</td></tr>\n<tr><td>\n\n[locale?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nstring \\| ((options: [RenderOptions](#renderoptions)<!-- -->) =&gt; string)\n\n\n</td><td>\n\n_(Optional)_ Language to use when rendering the document.\n\n\n</td></tr>\n<tr><td>\n\n[prefetchStrategy?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[PrefetchStrategy](#prefetchstrategy) \\| null\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[qwikLoader?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[QwikLoaderOptions](#qwikloaderoptions)\n\n\n</td><td>\n\n_(Optional)_ Specifies if the Qwik Loader script is added to the document or not.\n\nDefaults to `{ include: true }`<!-- -->.\n\n\n</td></tr>\n<tr><td>\n\n[qwikPrefetchServiceWorker?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nQwikPrefetchServiceWorkerOptions\n\n\n</td><td>\n\n_(Optional)_ Specifies if the Qwik Prefetch Service Worker script is added to the document or not.\n\nDefaults to `{ include: false }`<!-- -->. NOTE: This may be change in the future.\n\n\n</td></tr>\n<tr><td>\n\n[serverData?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nRecord&lt;string, any&gt;\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[snapshot?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Defaults to `true`\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.renderoptions.md"
},
{
@@ -167,7 +167,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface RenderResult \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[isStatic](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[manifest?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nQwikManifest\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[prefetchResources](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[PrefetchResource](#prefetchresource)<!-- -->\\[\\]\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[snapshotResult](#)\n\n\n</td><td>\n\n\n</td><td>\n\nSnapshotResult \\| undefined\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.renderresult.md"
},
{
@@ -181,7 +181,7 @@
],
"kind": "Function",
"content": "```typescript\nexport type RenderToStream = (opts: RenderToStreamOptions) => Promise<RenderToStreamResult>;\n```\n**References:** [RenderToStreamOptions](#rendertostreamoptions)<!-- -->, [RenderToStreamResult](#rendertostreamresult)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/render.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/render.ts",
"mdFile": "qwik.rendertostream.md"
},
{
@@ -195,7 +195,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type RenderToStream = (opts: RenderToStreamOptions) => Promise<RenderToStreamResult>;\n```\n**References:** [RenderToStreamOptions](#rendertostreamoptions)<!-- -->, [RenderToStreamResult](#rendertostreamresult)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.rendertostream.md"
},
{
@@ -209,7 +209,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface RenderToStreamOptions extends RenderOptions \n```\n**Extends:** [RenderOptions](#renderoptions)\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[stream](#)\n\n\n</td><td>\n\n\n</td><td>\n\nStreamWriter\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[streaming?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[StreamingOptions](#streamingoptions)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.rendertostreamoptions.md"
},
{
@@ -223,7 +223,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface RenderToStreamResult 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[flushes](#)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\n\n\n</td><td>\n\n\n</td></tr>\n<tr><td>\n\n[size](#)\n\n\n</td><td>\n\n\n</td><td>\n\nnumber\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/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.rendertostreamresult.md"
},
{
@@ -237,7 +237,7 @@
],
"kind": "Function",
"content": "```typescript\nexport type RenderToString = (opts: RenderToStringOptions) => Promise<RenderToStringResult>;\n```\n**References:** [RenderToStringOptions](#rendertostringoptions)<!-- -->, [RenderToStringResult](#rendertostringresult)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/render.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/render.ts",
"mdFile": "qwik.rendertostring.md"
},
{
@@ -251,7 +251,7 @@
],
"kind": "TypeAlias",
"content": "```typescript\nexport type RenderToString = (opts: RenderToStringOptions) => Promise<RenderToStringResult>;\n```\n**References:** [RenderToStringOptions](#rendertostringoptions)<!-- -->, [RenderToStringResult](#rendertostringresult)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.rendertostring.md"
},
{
@@ -265,7 +265,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface RenderToStringOptions extends RenderOptions \n```\n**Extends:** [RenderOptions](#renderoptions)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.rendertostringoptions.md"
},
{
@@ -279,7 +279,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>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.rendertostringresult.md"
},
{
@@ -293,7 +293,7 @@
],
"kind": "Function",
"content": "```typescript\nexport declare function resolveManifest(manifest: QwikManifest | ResolvedManifest | undefined): ResolvedManifest | undefined;\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nmanifest\n\n\n</td><td>\n\nQwikManifest \\| ResolvedManifest \\| undefined\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nResolvedManifest \\| undefined",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/render.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/render.ts",
"mdFile": "qwik.resolvemanifest.md"
},
{
@@ -307,7 +307,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface SerializeDocumentOptions \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[debug?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[manifest?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nQwikManifest \\| ResolvedManifest\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n<tr><td>\n\n[symbolMapper?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nSymbolMapperFn\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.serializedocumentoptions.md"
},
{
@@ -321,7 +321,7 @@
],
"kind": "Function",
"content": "```typescript\nexport declare function setServerPlatform(manifest: QwikManifest | ResolvedManifest | undefined): Promise<void>;\n```\n\n\n<table><thead><tr><th>\n\nParameter\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\nmanifest\n\n\n</td><td>\n\nQwikManifest \\| ResolvedManifest \\| undefined\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nPromise&lt;void&gt;",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/index.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/index.ts",
"mdFile": "qwik.setserverplatform.md"
},
{
@@ -335,7 +335,7 @@
],
"kind": "Interface",
"content": "```typescript\nexport interface StreamingOptions \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[inOrder?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[InOrderStreaming](#inorderstreaming)\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.streamingoptions.md"
},
{
@@ -349,7 +349,7 @@
],
"kind": "TypeAlias",
"content": "Auto: Prefetch all possible QRLs used by the document. Default\n\n\n```typescript\nexport type SymbolsToPrefetch = 'auto' | ((opts: {\n manifest: QwikManifest;\n}) => PrefetchResource[]);\n```\n**References:** [PrefetchResource](#prefetchresource)",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts",
"mdFile": "qwik.symbolstoprefetch.md"
},
{
@@ -363,7 +363,7 @@
],
"kind": "Variable",
"content": "```typescript\nversions: {\n readonly qwik: string;\n readonly qwikDom: string;\n}\n```",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/utils.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/utils.ts",
"mdFile": "qwik.versions.md"
}
]

52
packages/docs/src/routes/api/qwik-server/index.md
View File

@@ -43,7 +43,7 @@ _(Optional)_
string
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/scripts.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/scripts.ts)
## getQwikPrefetchWorkerScript
@@ -86,7 +86,7 @@ _(Optional)_
string
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/scripts.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/scripts.ts)
## InOrderAuto
@@ -156,7 +156,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts)
## InOrderDisabled
@@ -196,7 +196,7 @@ Description
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts)
## InOrderStreaming
@@ -206,7 +206,7 @@ export type InOrderStreaming = InOrderAuto | InOrderDisabled | InOrderDirect;
**References:** [InOrderAuto](#inorderauto), [InOrderDisabled](#inorderdisabled)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts)
## PrefetchImplementation
@@ -307,7 +307,7 @@ _(Optional)_ `always`: Always include the worker fetch JS runtime.
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts)
## PrefetchResource
@@ -360,7 +360,7 @@ string
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts)
## PrefetchStrategy
@@ -417,7 +417,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts)
## QwikLoaderOptions
@@ -474,7 +474,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts)
## Render
@@ -484,7 +484,7 @@ export type Render = RenderToString | RenderToStream;
**References:** [RenderToString](#rendertostring), [RenderToStream](#rendertostream)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts)
## RenderOptions
@@ -652,7 +652,7 @@ _(Optional)_ Defaults to `true`
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts)
## RenderResult
@@ -733,7 +733,7 @@ SnapshotResult \| undefined
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts)
## renderToStream
@@ -745,7 +745,7 @@ export type RenderToStream = (
**References:** [RenderToStreamOptions](#rendertostreamoptions), [RenderToStreamResult](#rendertostreamresult)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/render.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/render.ts)
## RenderToStream
@@ -757,7 +757,7 @@ export type RenderToStream = (
**References:** [RenderToStreamOptions](#rendertostreamoptions), [RenderToStreamResult](#rendertostreamresult)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts)
## RenderToStreamOptions
@@ -814,7 +814,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts)
## RenderToStreamResult
@@ -882,7 +882,7 @@ number
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts)
## renderToString
@@ -894,7 +894,7 @@ export type RenderToString = (
**References:** [RenderToStringOptions](#rendertostringoptions), [RenderToStringResult](#rendertostringresult)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/render.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/render.ts)
## RenderToString
@@ -906,7 +906,7 @@ export type RenderToString = (
**References:** [RenderToStringOptions](#rendertostringoptions), [RenderToStringResult](#rendertostringresult)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts)
## RenderToStringOptions
@@ -916,7 +916,7 @@ export interface RenderToStringOptions extends RenderOptions
**Extends:** [RenderOptions](#renderoptions)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts)
## RenderToStringResult
@@ -971,7 +971,7 @@ string
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts)
## resolveManifest
@@ -1010,7 +1010,7 @@ QwikManifest \| ResolvedManifest \| undefined
ResolvedManifest \| undefined
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/render.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/render.ts)
## SerializeDocumentOptions
@@ -1082,7 +1082,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts)
## setServerPlatform
@@ -1121,7 +1121,7 @@ QwikManifest \| ResolvedManifest \| undefined
Promise&lt;void&gt;
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/index.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/index.ts)
## StreamingOptions
@@ -1163,7 +1163,7 @@ _(Optional)_
</td></tr>
</tbody></table>
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts)
## SymbolsToPrefetch
@@ -1177,7 +1177,7 @@ export type SymbolsToPrefetch =
**References:** [PrefetchResource](#prefetchresource)
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/types.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/types.ts)
## versions
@@ -1188,4 +1188,4 @@ versions: {
}
```
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/server/utils.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/server/utils.ts)

2
packages/docs/src/routes/api/qwik-testing/api.json
View File

@@ -13,7 +13,7 @@
],
"kind": "Function",
"content": "CreatePlatform and CreateDocument\n\n\n```typescript\ncreateDOM: ({ html }?: {\n html?: string | undefined;\n}) => Promise<{\n render: (jsxElement: JSXOutput) => Promise<import(\"@builder.io/qwik\").RenderResult>;\n screen: HTMLElement;\n userEvent: (queryOrElement: string | Element | keyof HTMLElementTagNameMap | null, eventNameCamel: string | keyof WindowEventMap, eventPayload?: any) => Promise<void>;\n}>\n```\n\n\n<table><thead><tr><th>\n\nParameter\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{ html?: string \\| undefined; }\n\n\n</td><td>\n\n_(Optional)_\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nPromise&lt;{ render: (jsxElement: JSXOutput) =&gt; Promise&lt;import(\"@builder.io/qwik\").RenderResult&gt;; screen: HTMLElement; userEvent: (queryOrElement: string \\| Element \\| keyof HTMLElementTagNameMap \\| null, eventNameCamel: string \\| keyof WindowEventMap, eventPayload?: any) =&gt; Promise&lt;void&gt;; }&gt;",
"editUrl": "https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/testing/library.ts",
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/testing/library.ts",
"mdFile": "qwik.createdom.md"
}
]

2
packages/docs/src/routes/api/qwik-testing/index.md
View File

@@ -54,4 +54,4 @@ _(Optional)_
Promise&lt;{ render: (jsxElement: JSXOutput) =&gt; Promise&lt;import("@builder.io/qwik").RenderResult&gt;; screen: HTMLElement; userEvent: (queryOrElement: string \| Element \| keyof HTMLElementTagNameMap \| null, eventNameCamel: string \| keyof WindowEventMap, eventPayload?: any) =&gt; Promise&lt;void&gt;; }&gt;
[Edit this section](https://github.com/BuilderIO/qwik/tree/main/packages/qwik/src/testing/library.ts)
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/testing/library.ts)

442
packages/docs/src/routes/api/qwik/api.json
View File

File diff suppressed because one or more lines are too long

442
packages/docs/src/routes/api/qwik/index.md
View File

File diff suppressed because it is too large Load Diff

4
packages/docs/src/routes/community/projects/index.mdx
View File

@@ -41,7 +41,7 @@ created_at: '2023-02-03T20:09:34Z'
<div class="card-grid">
<a class="card card-center" href="https://github.com/qwikifiers/qwik-storefront-ui">
<p class="icon" align="center"><img src="https://raw.githubusercontent.com/BuilderIO/qwik/main/packages/docs/public/ecosystem/qwik-storefront-ui.png" width="256px"/></p>
<p class="icon" align="center"><img src="https://raw.githubusercontent.com/QwikDev/qwik/main/packages/docs/public/ecosystem/qwik-storefront-ui.png" width="256px"/></p>
<h3>UI library that helps developers create storefronts</h3>
</a>
</div>
@@ -86,4 +86,4 @@ created_at: '2023-02-03T20:09:34Z'
</a>
</div>
If you have more projects to add, please [edit this page](https://github.com/BuilderIO/qwik/edit/main/packages/docs/src/routes/community/projects/index.mdx)
If you have more projects to add, please [edit this page](https://github.com/QwikDev/qwik/edit/main/packages/docs/src/routes/community/projects/index.mdx)

2
packages/docs/src/routes/demo/cookbook/portal/portal-provider.tsx
View File

@@ -103,7 +103,7 @@ export const WrapJsxInContext = component$<{
});
return (
<>
{/* Workaround: https://github.com/BuilderIO/qwik/issues/4966 */}
{/* Workaround: https://github.com/QwikDev/qwik/issues/4966 */}
{/* {jsx} */}
{[jsx].map((jsx) => jsx)}
</>

2
packages/docs/src/routes/demo/state/no-serialize/.eslintrc.cjs
View File

@@ -1,4 +1,4 @@
// REMOVE THIS FILE ONCE: https://github.com/BuilderIO/qwik/issues/3719 is fixed
// REMOVE THIS FILE ONCE: https://github.com/QwikDev/qwik/issues/3719 is fixed
module.exports = {
root: true,
env: {

2
packages/docs/src/routes/demo/state/resource/index.tsx
View File

@@ -13,7 +13,7 @@ export default component$(() => {
// this means this code will run on the server and the browser
track(() => prNumber.value);
const response = await fetch(
`https://api.github.com/repos/BuilderIO/qwik/pulls/${prNumber.value}`
`https://api.github.com/repos/QwikDev/qwik/pulls/${prNumber.value}`
);
const data = await response.json();
return data.title as string;

2
packages/docs/src/routes/demo/tasks/resource/index.tsx
View File

@@ -11,7 +11,7 @@ export default component$(() => {
const prTitle = useResource$(async ({ track }) => {
track(() => prNumber.value); // Requires explicit tracking of inputs
const response = await fetch(
`https://api.github.com/repos/BuilderIO/qwik/pulls/${prNumber.value}`
`https://api.github.com/repos/QwikDev/qwik/pulls/${prNumber.value}`
);
const data = await response.json();
return (data.title || data.message || 'Error') as string;

42
packages/docs/src/routes/docs/(qwik)/advanced/eslint/index.mdx
View File

@@ -369,7 +369,7 @@ export const Counter = (() => {
```
<p class="code-description">`use*` methods can only be used in `component$` functions or inside `use*` hooks (e.g. `useCounter`).</p>
</div>
<div class="edit-examples-wrapper"><a href="https://github.com/BuilderIO/qwik/edit/main/packages/eslint-plugin-qwik/src/useMethodUsage.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<div class="edit-examples-wrapper"><a href="https://github.com/QwikDev/qwik/edit/main/packages/eslint-plugin-qwik/src/useMethodUsage.ts" target="_blank" class="edit-btn">Edit examples</a></div>
</div>
@@ -418,7 +418,7 @@ export const HelloWorld = component$(() => {
```
<p class="code-description">Since Expressions are not serializable, they must be wrapped with `$( ... )` so that the optimizer can split the code into small chunks.</p>
</div>
<div class="edit-examples-wrapper"><a href="https://github.com/BuilderIO/qwik/edit/main/packages/eslint-plugin-qwik/src/validLexicalScope.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<div class="edit-examples-wrapper"><a href="https://github.com/QwikDev/qwik/edit/main/packages/eslint-plugin-qwik/src/validLexicalScope.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<h4>invalidJsxDollar</h4>
<p>Examples of <b>correct</b> code for this rule:</p>
<div class="code-wrapper">
@@ -449,7 +449,7 @@ export const HelloWorld = component$(() => {
```
<p class="code-description">Event handler must be wrapped with `${ ... }`.</p>
</div>
<div class="edit-examples-wrapper"><a href="https://github.com/BuilderIO/qwik/edit/main/packages/eslint-plugin-qwik/src/validLexicalScope.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<div class="edit-examples-wrapper"><a href="https://github.com/QwikDev/qwik/edit/main/packages/eslint-plugin-qwik/src/validLexicalScope.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<h4>mutableIdentifier</h4>
<p>Examples of <b>correct</b> code for this rule:</p>
<div class="code-wrapper">
@@ -490,7 +490,7 @@ export const HelloWorld = component$(() => {
```
<p class="code-description">Simple values are not allowed to be mutated. Use an Object instead and edit one of its property.</p>
</div>
<div class="edit-examples-wrapper"><a href="https://github.com/BuilderIO/qwik/edit/main/packages/eslint-plugin-qwik/src/validLexicalScope.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<div class="edit-examples-wrapper"><a href="https://github.com/QwikDev/qwik/edit/main/packages/eslint-plugin-qwik/src/validLexicalScope.ts" target="_blank" class="edit-btn">Edit examples</a></div>
</div>
@@ -527,7 +527,7 @@ export const useProductDetails = routeLoader$(async (requestEvent) => {
```
<p class="code-description">This is not a valid location for a route loader. It only can be used inside the `src/routes` folder, in a `layout.tsx` or `index.tsx` file.</p>
</div>
<div class="edit-examples-wrapper"><a href="https://github.com/BuilderIO/qwik/edit/main/packages/eslint-plugin-qwik/src/loaderLocation.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<div class="edit-examples-wrapper"><a href="https://github.com/QwikDev/qwik/edit/main/packages/eslint-plugin-qwik/src/loaderLocation.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<h4>missingExport</h4>
<p>Examples of <b>correct</b> code for this rule:</p>
<div class="code-wrapper">
@@ -556,7 +556,7 @@ const useProductDetails = routeLoader$(async (requestEvent) => {
```
<p class="code-description">The route loader function must be exported.</p>
</div>
<div class="edit-examples-wrapper"><a href="https://github.com/BuilderIO/qwik/edit/main/packages/eslint-plugin-qwik/src/loaderLocation.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<div class="edit-examples-wrapper"><a href="https://github.com/QwikDev/qwik/edit/main/packages/eslint-plugin-qwik/src/loaderLocation.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<h4>wrongName</h4>
<p>Examples of <b>correct</b> code for this rule:</p>
<div class="code-wrapper">
@@ -585,7 +585,7 @@ export const getProductDetails = routeLoader$(async (requestEvent) => {
```
<p class="code-description">The route loader function name must start with `use`.</p>
</div>
<div class="edit-examples-wrapper"><a href="https://github.com/BuilderIO/qwik/edit/main/packages/eslint-plugin-qwik/src/loaderLocation.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<div class="edit-examples-wrapper"><a href="https://github.com/QwikDev/qwik/edit/main/packages/eslint-plugin-qwik/src/loaderLocation.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<h4>recommendedValue</h4>
<p>Examples of <b>correct</b> code for this rule:</p>
<div class="code-wrapper">
@@ -616,7 +616,7 @@ export const useProductDetails = routeLoader$(fetcher);
```
<p class="code-description">It is recommended to inline the arrow function. This will help the optimizer make sure that no server code is leaked to the client build.</p>
</div>
<div class="edit-examples-wrapper"><a href="https://github.com/BuilderIO/qwik/edit/main/packages/eslint-plugin-qwik/src/loaderLocation.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<div class="edit-examples-wrapper"><a href="https://github.com/QwikDev/qwik/edit/main/packages/eslint-plugin-qwik/src/loaderLocation.ts" target="_blank" class="edit-btn">Edit examples</a></div>
</div>
@@ -641,7 +641,7 @@ export const useProductDetails = routeLoader$(fetcher);
```
<p class="code-description">Prefer `class` and `for` props over `className` and `htmlFor`.</p>
</div>
<div class="edit-examples-wrapper"><a href="https://github.com/BuilderIO/qwik/edit/main/packages/eslint-plugin-qwik/src/noReactProps.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<div class="edit-examples-wrapper"><a href="https://github.com/QwikDev/qwik/edit/main/packages/eslint-plugin-qwik/src/noReactProps.ts" target="_blank" class="edit-btn">Edit examples</a></div>
</div>
@@ -697,7 +697,7 @@ export default component$((props) => {
```
<p class="code-description">The class prop should be used instead of any 3rd party lib to efficiently set classes based on an object.</p>
</div>
<div class="edit-examples-wrapper"><a href="https://github.com/BuilderIO/qwik/edit/main/packages/eslint-plugin-qwik/src/preferClasslist.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<div class="edit-examples-wrapper"><a href="https://github.com/QwikDev/qwik/edit/main/packages/eslint-plugin-qwik/src/preferClasslist.ts" target="_blank" class="edit-btn">Edit examples</a></div>
</div>
@@ -721,7 +721,7 @@ export default component$((props) => {
<button onClick$="javascript:alert('open the door please')">ring</button>
```
</div>
<div class="edit-examples-wrapper"><a href="https://github.com/BuilderIO/qwik/edit/main/packages/eslint-plugin-qwik/src/jsxNoScriptUrl.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<div class="edit-examples-wrapper"><a href="https://github.com/QwikDev/qwik/edit/main/packages/eslint-plugin-qwik/src/jsxNoScriptUrl.ts" target="_blank" class="edit-btn">Edit examples</a></div>
</div>
@@ -778,7 +778,7 @@ export const Person = component$(() => {
```
<p class="code-description">Missing `key` prop for element in iterator.</p>
</div>
<div class="edit-examples-wrapper"><a href="https://github.com/BuilderIO/qwik/edit/main/packages/eslint-plugin-qwik/src/jsxKey.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<div class="edit-examples-wrapper"><a href="https://github.com/QwikDev/qwik/edit/main/packages/eslint-plugin-qwik/src/jsxKey.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<h4>missingIterKeyUsePrag</h4>
<p>Examples of <b>correct</b> code for this rule:</p>
<div class="code-wrapper">
@@ -833,7 +833,7 @@ export const Person = component$(() => {
```
<p class="code-description">Missing `key` prop for element in iterator. The key prop allows for improved rendering performance. Shorthand fragment syntax does not support providing keys. Use `<Fragment>` instead</p>
</div>
<div class="edit-examples-wrapper"><a href="https://github.com/BuilderIO/qwik/edit/main/packages/eslint-plugin-qwik/src/jsxKey.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<div class="edit-examples-wrapper"><a href="https://github.com/QwikDev/qwik/edit/main/packages/eslint-plugin-qwik/src/jsxKey.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<h4>missingArrayKey</h4>
<p>Examples of <b>correct</b> code for this rule:</p>
<div class="code-wrapper">
@@ -874,7 +874,7 @@ export const ColorList = component$(() => {
```
<p class="code-description">Missing `key` prop for element in array. The key prop allows for improved rendering performance.</p>
</div>
<div class="edit-examples-wrapper"><a href="https://github.com/BuilderIO/qwik/edit/main/packages/eslint-plugin-qwik/src/jsxKey.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<div class="edit-examples-wrapper"><a href="https://github.com/QwikDev/qwik/edit/main/packages/eslint-plugin-qwik/src/jsxKey.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<h4>missingArrayKeyUsePrag</h4>
<p>Examples of <b>correct</b> code for this rule:</p>
<div class="code-wrapper">
@@ -917,7 +917,7 @@ export const ColorList = component$(() => {
```
<p class="code-description">Missing `key` prop for element in array. The key prop allows for improved rendering performance. Shorthand fragment syntax does not support providing keys. Use `<Fragment>` instead</p>
</div>
<div class="edit-examples-wrapper"><a href="https://github.com/BuilderIO/qwik/edit/main/packages/eslint-plugin-qwik/src/jsxKey.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<div class="edit-examples-wrapper"><a href="https://github.com/QwikDev/qwik/edit/main/packages/eslint-plugin-qwik/src/jsxKey.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<h4>nonUniqueKeys</h4>
<p>Examples of <b>correct</b> code for this rule:</p>
<div class="code-wrapper">
@@ -958,7 +958,7 @@ export const ColorList = component$(() => {
```
<p class="code-description">The `key` prop must be unique.</p>
</div>
<div class="edit-examples-wrapper"><a href="https://github.com/BuilderIO/qwik/edit/main/packages/eslint-plugin-qwik/src/jsxKey.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<div class="edit-examples-wrapper"><a href="https://github.com/QwikDev/qwik/edit/main/packages/eslint-plugin-qwik/src/jsxKey.ts" target="_blank" class="edit-btn">Edit examples</a></div>
</div>
@@ -1019,7 +1019,7 @@ export default component$(() => (
```
<p class="code-description">A `server$` function is declared, but never used.</p>
</div>
<div class="edit-examples-wrapper"><a href="https://github.com/BuilderIO/qwik/edit/main/packages/eslint-plugin-qwik/src/unusedServer.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<div class="edit-examples-wrapper"><a href="https://github.com/QwikDev/qwik/edit/main/packages/eslint-plugin-qwik/src/unusedServer.ts" target="_blank" class="edit-btn">Edit examples</a></div>
</div>
@@ -1045,7 +1045,7 @@ import Image from '~/media/image.png';
```
<p class="code-description">Serving images from public are not optimized, nor cached. Import images using ESM instead.</p>
</div>
<div class="edit-examples-wrapper"><a href="https://github.com/BuilderIO/qwik/edit/main/packages/eslint-plugin-qwik/src/jsxImg.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<div class="edit-examples-wrapper"><a href="https://github.com/QwikDev/qwik/edit/main/packages/eslint-plugin-qwik/src/jsxImg.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<h4>noWidthHeight</h4>
<p>Examples of <b>correct</b> code for this rule:</p>
<div class="code-wrapper">
@@ -1062,7 +1062,7 @@ import Image from '~/media/image.png';
```
<p class="code-description">For performance reasons, always provide width and height attributes for `<img>` elements, it will help to prevent layout shifts.</p>
</div>
<div class="edit-examples-wrapper"><a href="https://github.com/BuilderIO/qwik/edit/main/packages/eslint-plugin-qwik/src/jsxImg.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<div class="edit-examples-wrapper"><a href="https://github.com/QwikDev/qwik/edit/main/packages/eslint-plugin-qwik/src/jsxImg.ts" target="_blank" class="edit-btn">Edit examples</a></div>
</div>
@@ -1072,7 +1072,7 @@ import Image from '~/media/image.png';
<span>For a perfect SEO score, always provide href attribute for &lt;a&gt; elements.</span>
<h4>noHref</h4>
<div class="edit-examples-wrapper"><a href="https://github.com/BuilderIO/qwik/edit/main/packages/eslint-plugin-qwik/src/jsxA.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<div class="edit-examples-wrapper"><a href="https://github.com/QwikDev/qwik/edit/main/packages/eslint-plugin-qwik/src/jsxA.ts" target="_blank" class="edit-btn">Edit examples</a></div>
</div>
@@ -1082,7 +1082,7 @@ import Image from '~/media/image.png';
<span>Detect useVisibleTask$() functions.</span>
<h4>noUseVisibleTask</h4>
<div class="edit-examples-wrapper"><a href="https://github.com/BuilderIO/qwik/edit/main/packages/eslint-plugin-qwik/src/noUseVisibleTask.ts" target="_blank" class="edit-btn">Edit examples</a></div>
<div class="edit-examples-wrapper"><a href="https://github.com/QwikDev/qwik/edit/main/packages/eslint-plugin-qwik/src/noUseVisibleTask.ts" target="_blank" class="edit-btn">Edit examples</a></div>
</div>

2
packages/docs/src/routes/docs/(qwik)/components/state/index.mdx
View File

@@ -252,7 +252,7 @@ export default component$(() => {
// this means this code will run on the server and the browser
track(() => prNumber.value);
const response = await fetch(
`https://api.github.com/repos/BuilderIO/qwik/pulls/${prNumber.value}`
`https://api.github.com/repos/QwikDev/qwik/pulls/${prNumber.value}`
);
const data = await response.json();
return data.title as string;

4
packages/docs/src/routes/docs/(qwik)/faq/index.mdx
View File

@@ -282,7 +282,7 @@ Most of Qwik is written in [TypeScript](https://www.typescriptlang.org/), a supe
## Does Qwik have a community?
Yes! there is a growing community of Qwik developers at [Discord](https://qwik.dev/chat) and [GitHub](https://github.com/BuilderIO/qwik). They are making amazing contributions to the framework, building sites at scale, and helping each other. [Join us](https://qwik.dev/chat).
Yes! there is a growing community of Qwik developers at [Discord](https://qwik.dev/chat) and [GitHub](https://github.com/QwikDev/qwik). They are making amazing contributions to the framework, building sites at scale, and helping each other. [Join us](https://qwik.dev/chat).
## Is Qwik an "Alex Russell Approved" framework?
@@ -304,7 +304,7 @@ An amazing team of contributors around the world living in [Discord](https://qwi
## Is Qwik open source?
Yes, [MIT](https://github.com/BuilderIO/qwik/blob/main/LICENSE) and [dependency-free](https://github.com/BuilderIO/qwik/blob/main/packages/qwik/package.json), installing Qwik will not bloat your node_modules nor your lawyers.
Yes, [MIT](https://github.com/QwikDev/qwik/blob/main/LICENSE) and [dependency-free](https://github.com/QwikDev/qwik/blob/main/packages/qwik/package.json), installing Qwik will not bloat your node_modules nor your lawyers.
## Does Qwik have any downsides?

4
packages/docs/src/routes/docs/(qwikcity)/guides/react-cheat-sheet/index.mdx
View File

@@ -226,7 +226,7 @@ export const Clock = component$(() => {
```tsx
export function Fetch() {
const [url, setUrl] = useState('https://api.github.com/repos/BuilderIO/qwik');
const [url, setUrl] = useState('https://api.github.com/repos/QwikDev/qwik');
const [responseJson, setResponseJson] = useState(undefined);
useEffect(() => {
@@ -248,7 +248,7 @@ export function Fetch() {
```tsx
export const Fetch = component$(() => {
const url = useSignal('https://api.github.com/repos/BuilderIO/qwik');
const url = useSignal('https://api.github.com/repos/QwikDev/qwik');
const responseJson = useSignal(undefined);
useTask$(async ({ track }) => {

2
packages/docs/src/routes/docs/(qwikcity)/routing/index.mdx
View File

@@ -235,7 +235,7 @@ export default component$(() => {
});
```
> The `Link` component uses the `useNavigate()` hook [internally](https://github.com/BuilderIO/qwik/blob/e452582f4728cbcb7bf85d03293e757302286683/packages/qwik-city/runtime/src/link-component.tsx#L33).
> The `Link` component uses the `useNavigate()` hook [internally](https://github.com/QwikDev/qwik/blob/e452582f4728cbcb7bf85d03293e757302286683/packages/qwik-city/runtime/src/link-component.tsx#L33).
### `<Link reload>`

2
packages/docs/src/routes/docs/cookbook/portals/index.mdx
View File

@@ -301,7 +301,7 @@ export const WrapJsxInContext = component$<{
});
return (
<>
{/* Workaround: https://github.com/BuilderIO/qwik/issues/4966 */}
{/* Workaround: https://github.com/QwikDev/qwik/issues/4966 */}
{/* {jsx} */}
{[jsx].map((jsx) => jsx)}
</>

4
packages/docs/src/routes/docs/deployments/cloudflare-pages/index.mdx
View File

@@ -55,7 +55,7 @@ To build the application for production, use the `build` command, this command w
npm run build
```
[Read the full guide here](https://github.com/BuilderIO/qwik/tree/main/starters/adapters/cloudflare-pages/README.md)
[Read the full guide here](https://github.com/QwikDev/qwik/tree/main/starters/adapters/cloudflare-pages/README.md)
## Deploy to Cloudflare Pages
@@ -102,7 +102,7 @@ import { fetch } from "../server/entry.cloudflare-pages";
export default { fetch };
```
- [Cloudflare Pages Middleware Source](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware/cloudflare-pages/index.ts)
- [Cloudflare Pages Middleware Source](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware/cloudflare-pages/index.ts)
- [Cloudflare Pages Advanced Mode](https://developers.cloudflare.com/pages/platform/functions/advanced-mode/)
- [Function Invocation Route Config](https://developers.cloudflare.com/pages/platform/functions/routing/#functions-invocation-routes)

8
packages/docs/src/routes/docs/deployments/index.mdx
View File

@@ -39,11 +39,11 @@ npm run build
The `requestHandler()` utility is what each of the above middleware bundles uses in order to translate their request/response to a standard format for Qwik City to use. This function can be used to provide middleware for specific server frameworks.
If there's middleware missing and you'd like it added, take a look at how the `requestHandler()` utility is used to handle requests for each of the middleware source-code above. Better yet, we'd love to have your middleware contributions! [PR's are welcome](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware)!
If there's middleware missing and you'd like it added, take a look at how the `requestHandler()` utility is used to handle requests for each of the middleware source-code above. Better yet, we'd love to have your middleware contributions! [PR's are welcome](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware)!
## Add A New Deployment
Thanks for your interest in adding a deployment integration to Qwik! We're more than happy to help you get started. Before we get too far, if there's already a deployment for what you're looking for, we'd [love to have you contribute to it](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters). If the deployment is not already available, let's add it!
Thanks for your interest in adding a deployment integration to Qwik! We're more than happy to help you get started. Before we get too far, if there's already a deployment for what you're looking for, we'd [love to have you contribute to it](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters). If the deployment is not already available, let's add it!
To start it's probably best to copy an existing adapters and middleware and modify it to fit your needs. A deployment is made up of a few different parts:
@@ -53,7 +53,7 @@ An adapter is the term used to summarize the Vite config that needed for the spe
The adapter is really a Vite config, that's extending the base config. The base config is the same for all adapters, and the adapter config is the unique part for each server.
- [Adapters Source](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/adapters)
- [Adapters Source](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/adapters)
### Add Middleware
@@ -63,7 +63,7 @@ Luckily Qwik City uses the standardized [Request](https://developer.mozilla.org/
For middleware, you'll notice that each one calls the common `@builder.io/qwik-city/middleware/request-handler` package. The job of each middleware is to translate the request and response to the standardized format that Qwik City request handler package uses.
- [Middleware Source](https://github.com/BuilderIO/qwik/tree/main/packages/qwik-city/middleware)
- [Middleware Source](https://github.com/QwikDev/qwik/tree/main/packages/qwik-city/middleware)
### Add To The Starter CLI

4
packages/docs/src/routes/docs/deployments/netlify-edge/index.mdx
View File

@@ -44,7 +44,7 @@ To build the application for production, use the `build` command, this command w
npm run build
```
[Read the full guide here](https://github.com/BuilderIO/qwik/blob/main/starters/adapters/netlify-edge/README.md)
[Read the full guide here](https://github.com/QwikDev/qwik/blob/main/starters/adapters/netlify-edge/README.md)
## Dev deploy
@@ -113,4 +113,4 @@ export const onRequest = async ({ env }) => {
```
- [Netlify Environment Variables](https://docs.netlify.com/environment-variables/overview/#environment-variable-options)
- [Netlify Edge Middleware Source](https://github.com/BuilderIO/qwik/blob/main/packages/qwik-city/middleware/netlify-edge/index.ts)
- [Netlify Edge Middleware Source](https://github.com/QwikDev/qwik/blob/main/packages/qwik-city/middleware/netlify-edge/index.ts)

2
packages/docs/src/routes/docs/deployments/vercel-edge/index.mdx
View File

@@ -46,7 +46,7 @@ To build the application for production, use the `build` command, this command w
npm run build
```
[Read the full guide here](https://github.com/BuilderIO/qwik/blob/main/starters/adapters/vercel-edge/README.md)
[Read the full guide here](https://github.com/QwikDev/qwik/blob/main/starters/adapters/vercel-edge/README.md)
## Dev deploy

2
packages/docs/src/routes/docs/menu.md
View File

@@ -149,7 +149,7 @@
## Community
- [GitHub](https://github.com/BuilderIO/qwik)
- [GitHub](https://github.com/QwikDev/qwik)
- [@QwikDev](https://twitter.com/QwikDev)
- [Discord](https://qwik.dev/chat)
- [Community Projects](/community/projects/index.mdx)

2
packages/docs/src/routes/examples/[...id]/index!.tsx
View File

@@ -126,7 +126,7 @@ export default component$(() => {
</article>
))}
<a
href="https://github.com/BuilderIO/qwik/tree/main/packages/docs/src/routes/examples/apps/"
href="https://github.com/QwikDev/qwik/tree/main/packages/docs/src/routes/examples/apps/"
class="example-button-new"
target="_blank"
>

7
packages/docs/src/routes/examples/apps/partial/hackernews-index/app.tsx
View File

@@ -41,12 +41,7 @@ export const Nav = component$(() => {
<a href="/?type=job">
<strong>Jobs</strong>
</a>
<a
class="github"
href="http://github.com/builderio/qwik"
target="_blank"
rel="noreferrer"
>
<a class="github" href="http://github.com/QwikDev/qwik" target="_blank" rel="noreferrer">
Built with Qwik
</a>
</nav>

4
packages/docs/src/routes/tutorial/introduction/component/index.mdx
View File

@@ -28,13 +28,13 @@ The HTML code for this component should be this:
<p>
<label>
GitHub organization:
<input value="BuilderIO" />
<input value="QwikDev" />
</label>
</p>
<section>
<ul>
<li>
<a href="https://github.com/BuilderIO/qwik">Qwik</a>
<a href="https://github.com/QwikDev/qwik">Qwik</a>
</li>
<li>
<a href="https://github.com/BuilderIO/partytown">Partytown</a>

4
packages/docs/src/routes/tutorial/introduction/component/solution/app.tsx
View File

@@ -6,13 +6,13 @@ export default component$(() => {
<p>
<label>
GitHub organization:
<input value="BuilderIO" />
<input value="QwikDev" />
</label>
</p>
<section>
<ul>
<li>
<a href="https://github.com/BuilderIO/qwik">Qwik</a>
<a href="https://github.com/QwikDev/qwik">Qwik</a>
</li>
<li>
<a href="https://github.com/BuilderIO/partytown">Partytown</a>

2
packages/docs/src/routes/tutorial/introduction/listeners/problem/app.tsx
View File

@@ -2,7 +2,7 @@ import { component$, useStore } from '@builder.io/qwik';
export default component$(() => {
const github = useStore({
org: 'BuilderIO',
org: 'QwikDev',
repos: ['qwik', 'partytown'] as string[] | null,
});

2
packages/docs/src/routes/tutorial/introduction/listeners/solution/app.tsx
View File

@@ -2,7 +2,7 @@ import { component$, useStore } from '@builder.io/qwik';
export default component$(() => {
const github = useStore({
org: 'BuilderIO',
org: 'QwikDev',
repos: ['qwik', 'partytown'] as string[] | null,
});

2
packages/docs/src/routes/tutorial/introduction/resource/problem/app.tsx
View File

@@ -3,7 +3,7 @@ import { component$, useStore, Resource, useResource$ } from '@builder.io/qwik';
export default component$(() => {
const github = useStore({
org: 'BuilderIO',
org: 'QwikDev',
});
// Use useResource$() to set up how the data is fetched from the server.

2
packages/docs/src/routes/tutorial/introduction/resource/solution/app.tsx
View File

@@ -3,7 +3,7 @@ import { component$, useStore, Resource, useResource$ } from '@builder.io/qwik';
export default component$(() => {
const github = useStore({
org: 'BuilderIO',
org: 'QwikDev',
});
const reposResource = useResource$<string[]>(({ track, cleanup }) => {

2
packages/docs/src/routes/tutorial/introduction/store/problem/app.tsx
View File

@@ -4,7 +4,7 @@ export default component$(() => {
// `github` is just a constant object.
// Convert it to a Store that can be serialized to JSON on application pause.
const github = {
org: 'BuilderIO',
org: 'QwikDev',
repos: ['qwik', 'partytown'] as string[] | null,
};

2
packages/docs/src/routes/tutorial/introduction/store/solution/app.tsx
View File

@@ -2,7 +2,7 @@ import { component$, useStore } from '@builder.io/qwik';
export default component$(() => {
const github = useStore({
org: 'BuilderIO',
org: 'QwikDev',
repos: ['qwik', 'partytown'] as string[] | null,
});

2
packages/docs/src/routes/tutorial/layout.tsx
View File

@@ -72,7 +72,7 @@ export default component$(() => {
) : null}
<a
class="edit-tutorial"
href={`https://github.com/BuilderIO/qwik/edit/main/packages/docs/src/routes/tutorial/${store.appId}`}
href={`https://github.com/QwikDev/qwik/edit/main/packages/docs/src/routes/tutorial/${store.appId}`}
target="_blank"
>
<EditIcon width={16} height={16} />

2
packages/docs/src/routes/tutorial/reactivity/resource/problem/app.tsx
View File

@@ -3,7 +3,7 @@ import { component$, useStore, Resource, useResource$ } from '@builder.io/qwik';
export default component$(() => {
const github = useStore({
org: 'BuilderIO',
org: 'QwikDev',
});
// Use useResource$() to set up how the data is fetched from the server.

2
packages/docs/src/routes/tutorial/reactivity/resource/solution/app.tsx
View File

@@ -3,7 +3,7 @@ import { component$, useStore, Resource, useResource$ } from '@builder.io/qwik';
export default component$(() => {
const github = useStore({
org: 'BuilderIO',
org: 'QwikDev',
});
const reposResource = useResource$<string[]>(({ track, cleanup }) => {

6
packages/eslint-plugin-qwik/package.json
View File

@@ -3,7 +3,7 @@
"description": "An Open-Source sub-framework designed with a focus on server-side-rendering, lazy-loading, and styling/animation.",
"version": "1.5.2",
"author": "Builder Team",
"bugs": "https://github.com/BuilderIO/qwik/issues",
"bugs": "https://github.com/QwikDev/qwik/issues",
"dependencies": {
"jsx-ast-utils": "^3.3.5"
},
@@ -18,7 +18,7 @@
"engines": {
"node": ">=16.8.0 <18.0.0 || >=18.11"
},
"homepage": "https://github.com/BuilderIO/qwik#readme",
"homepage": "https://github.com/QwikDev/qwik#readme",
"keywords": [
"builder.io",
"eslint",
@@ -31,7 +31,7 @@
},
"repository": {
"type": "git",
"url": "https://github.com/BuilderIO/qwik.git",
"url": "https://github.com/QwikDev/qwik.git",
"directory": "packages/eslint-rules"
},
"scripts": {

2
packages/insights/README.md
View File

@@ -2,7 +2,7 @@
- [Qwik Docs](https://qwik.dev/)
- [Discord](https://qwik.dev/chat)
- [Qwik GitHub](https://github.com/BuilderIO/qwik)
- [Qwik GitHub](https://github.com/QwikDev/qwik)
- [@QwikDev](https://twitter.com/QwikDev)
- [Vite](https://vitejs.dev/)

2
packages/insights/src/components/popup-manager/index.tsx
View File

@@ -32,7 +32,7 @@ export const PopupManager = component$(() => {
bubbles: false,
detail: {
show<T extends {}>(component: Component<T>, props: T) {
// TODO: Remove cast once https://github.com/BuilderIO/qwik/issues/4794 is fixed
// TODO: Remove cast once https://github.com/QwikDev/qwik/issues/4794 is fixed
(popup as { Component: any }).Component = component;
popup.props = props;
popup.currentTarget = target;

4
packages/insights/src/components/symbol-tile/index.tsx
View File

@@ -128,8 +128,8 @@ const serverGetSourceSnippet = server$(async function (publicApiKey: string, sym
let url: URL | null = null;
let rawUrl: URL | null = null;
if (publicApiKey == '221smyuj5gl') {
const rawGithub = 'https://raw.githubusercontent.com/BuilderIO/qwik/main/packages/docs/src/';
const github = 'https://github.com/BuilderIO/qwik/blob/main/packages/docs/src/';
const rawGithub = 'https://raw.githubusercontent.com/QwikDev/qwik/main/packages/docs/src/';
const github = 'https://github.com/QwikDev/qwik/blob/main/packages/docs/src/';
rawUrl = new URL(rawGithub);
url = new URL(github);
if (symbolDetail.origin.startsWith('./')) {

2
packages/insights/src/db/query.ts
View File

@@ -153,7 +153,7 @@ export async function getAppInfo(
return {
github:
publicApiKey == '221smyuj5gl'
? 'https://github.com/BuilderIO/qwik/blob/main/packages/docs/src'
? 'https://github.com/QwikDev/qwik/blob/main/packages/docs/src'
: null,
...app!,
};

2
packages/qwik-auth/README.md
View File

@@ -51,7 +51,7 @@ npm run build.server
## Related
- [Qwik Docs](https://qwik.dev/docs/)
- [Qwik on GitHub](https://github.com/BuilderIO/qwik)
- [Qwik on GitHub](https://github.com/QwikDev/qwik)
- [@QwikDev](https://twitter.com/QwikDev)
- [Discord](https://qwik.dev/chat)
- [Vite](https://vitejs.dev/)

Some files were not shown because too many files have changed in this diff Show More