Skip to content

Commit ec56c4d

Browse files
committed
clarify deferUpdates default
1 parent 4460b3a commit ec56c4d

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

packages/docs/src/routes/api/qwik/api.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2304,7 +2304,7 @@
23042304
}
23052305
],
23062306
"kind": "Interface",
2307-
"content": "```typescript\nexport interface TaskOptions \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[deferUpdates?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ If true, the task will block the rendering of the component until it is complete.\n\n\n</td></tr>\n</tbody></table>",
2307+
"content": "```typescript\nexport interface TaskOptions \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[deferUpdates?](#)\n\n\n</td><td>\n\n\n</td><td>\n\nboolean\n\n\n</td><td>\n\n_(Optional)_ Block the rendering of the component until the task completes. Default is `true`\n\n\n</td></tr>\n</tbody></table>",
23082308
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/use/use-task.ts",
23092309
"mdFile": "core.taskoptions.md"
23102310
},

packages/docs/src/routes/api/qwik/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8860,7 +8860,7 @@ boolean
88608860
88618861
</td><td>
88628862
8863-
_(Optional)_ If true, the task will block the rendering of the component until it is complete.
8863+
_(Optional)_ Block the rendering of the component until the task completes. Default is `true`
88648864
88658865
</td></tr>
88668866
</tbody></table>

packages/qwik/src/core/use/use-task.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ export interface DescriptorBase<T = unknown, B = unknown> extends BackRef {
136136

137137
/** @public */
138138
export interface TaskOptions {
139-
/** If true, the task will block the rendering of the component until it is complete. */
139+
/** Block the rendering of the component until the task completes. Default is `true` */
140140
deferUpdates?: boolean;
141141
}
142142

0 commit comments

Comments
 (0)