deprecated useTask$ eagerness (#7345)

* deprecated eagerness

* reviewd changes

* added changeset

Author: sreeisalso

.changeset/poor-numbers-yawn.md

@@ -0,0 +1,5 @@
+---
+'@builder.io/qwik': minor
+---
+
+The `useTask$` function's `eagerness` option is deprecated and will be removed in version 2.

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

@@ -726,7 +726,7 @@
         }
       ],
       "kind": "TypeAlias",
-      "content": "```typescript\nexport type EagernessOptions = 'visible' | 'load' | 'idle';\n```",
+      "content": "> Warning: This API is now obsolete.\n> \n> use useVisibleTask$ or useResource$, useTask$ is for running tasks as part of the initial SSR render\n> \n\n\n```typescript\nexport type EagernessOptions = 'visible' | 'load' | 'idle';\n```",
       "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/use/use-task.ts",
       "mdFile": "qwik.eagernessoptions.md"
     },
@@ -1774,7 +1774,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\nInstall a service worker which will prefetch the bundles.\n\nThere can only be one service worker per page. Because there can be many separate Qwik Containers on the page each container needs to load its prefetch graph using `PrefetchGraph` component.\n\n\n```typescript\nPrefetchServiceWorker: (opts: {\n    base?: string;\n    scope?: string;\n    path?: string;\n    verbose?: boolean;\n    fetchBundleGraph?: boolean;\n    nonce?: string;\n}) => 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\nopts\n\n\n</td><td>\n\n{ base?: string; scope?: string; path?: string; verbose?: boolean; fetchBundleGraph?: boolean; nonce?: string; }\n\n\n</td><td>\n\nOptions for the prefetch service worker.\n\n- `base` - Base URL for the service worker `import.meta.env.BASE_URL` or `/`<!-- -->. Default is `import.meta.env.BASE_URL` - `scope` - Base URL for when the service-worker will activate. Default is `/` - `path` - Path to the service worker. Default is `qwik-prefetch-service-worker.js` unless you pass a path that starts with a `/` then the base is ignored. Default is `qwik-prefetch-service-worker.js` - `verbose` - Verbose logging for the service worker installation. Default is `false` - `nonce` - Optional nonce value for security purposes, defaults to `undefined`<!-- -->.\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nJSXNode&lt;'script'&gt;",
+      "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\nInstall a service worker which will prefetch the bundles.\n\nThere can only be one service worker per page. Because there can be many separate Qwik Containers on the page each container needs to load its prefetch graph using `PrefetchGraph` component.\n\n\n```typescript\nPrefetchServiceWorker: (opts: {\n    base?: string;\n    scope?: string;\n    path?: string;\n    verbose?: boolean;\n    fetchBundleGraph?: boolean;\n    nonce?: string;\n}) => 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\nopts\n\n\n</td><td>\n\n{ base?: string; scope?: string; path?: string; verbose?: boolean; fetchBundleGraph?: boolean; nonce?: string; }\n\n\n</td><td>\n\nOptions for the prefetch service worker.\n\n- `base` - Base URL for the service worker `import.meta.env.BASE_URL` or `/`<!-- -->. Default is `import.meta.env.BASE_URL` - `scope` - Base URL for when the service-worker will activate. Default is `/` - `path` - Path to the service worker. Default is `qwik-prefetch-service-worker.js` unless you pass a path that starts with a `/` then the base is ignored. Default is `qwik-prefetch-service-worker.js` - `verbose` - Verbose logging for the service worker installation. Default is `false` - `nonce` - Optional nonce value for security purposes, defaults to `undefined`<!-- -->.\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\n[JSXNode](#jsxnode)<!-- -->&lt;'script'&gt;",
       "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/components/prefetch.ts",
       "mdFile": "qwik.prefetchserviceworker.md"
     },
@@ -3356,7 +3356,7 @@
         }
       ],
       "kind": "Interface",
-      "content": "```typescript\nexport interface UseTaskOptions \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[eagerness?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[EagernessOptions](#eagernessoptions)\n\n\n</td><td>\n\n_(Optional)_ - `visible`<!-- -->: run the effect when the element is visible. - `load`<!-- -->: eagerly run the effect when the application resumes.\n\n\n</td></tr>\n</tbody></table>",
+      "content": "> Warning: This API is now obsolete.\n> \n> use useVisibleTask$ or useResource$, useTask$ is for running tasks as part of the initial SSR render\n> \n\n\n```typescript\nexport interface UseTaskOptions \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[eagerness?](#)\n\n\n</td><td>\n\n\n</td><td>\n\n[EagernessOptions](#eagernessoptions)\n\n\n</td><td>\n\n_(Optional)_ - `visible`<!-- -->: run the effect when the element is visible. - `load`<!-- -->: eagerly run the effect when the application resumes.\n\n\n</td></tr>\n</tbody></table>",
       "editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/use/use-task.ts",
       "mdFile": "qwik.usetaskoptions.md"
     },

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

@@ -2052,6 +2052,10 @@ _(Optional)_
 
 ## EagernessOptions
 
+> Warning: This API is now obsolete.
+>
+> use useVisibleTask$ or useResource$, useTask$ is for running tasks as part of the initial SSR render
+
 ```typescript
 export type EagernessOptions = "visible" | "load" | "idle";
 ```
@@ -3653,7 +3657,7 @@ Options for the prefetch service worker.
 </tbody></table>
 **Returns:**
 
-JSXNode&lt;'script'&gt;
+[JSXNode](#jsxnode)&lt;'script'&gt;
 
 [Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/components/prefetch.ts)
 
@@ -11291,6 +11295,10 @@ void
 
 ## UseTaskOptions
 
+> Warning: This API is now obsolete.
+>
+> use useVisibleTask$ or useResource$, useTask$ is for running tasks as part of the initial SSR render
+
 ```typescript
 export interface UseTaskOptions
 ```

packages/qwik/src/core/api.md

@@ -217,7 +217,7 @@ export interface DOMAttributes<EL extends Element> extends DOMAttributesBase<EL>
     class?: ClassList | Signal<ClassList> | undefined;
 }
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export type EagernessOptions = 'visible' | 'load' | 'idle';
 
 // @public (undocumented)
@@ -1728,7 +1728,7 @@ export const useStylesScopedQrl: (styles: QRL<string>) => UseStylesScoped;
 // @public
 export const useTask$: (qrl: TaskFn, opts?: UseTaskOptions | undefined) => void;
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export interface UseTaskOptions {
     eagerness?: EagernessOptions;
 }

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

@@ -186,7 +186,7 @@ export interface DescriptorBase<T = unknown, B = unknown> {
   $state$: B | undefined;
 }
 
-/** @public */
+/** @public @deprecated use useVisibleTask$ or useResource$, useTask$ is for running tasks as part of the initial SSR render */
 export type EagernessOptions = 'visible' | 'load' | 'idle';
 
 /** @public */
@@ -207,7 +207,7 @@ export interface OnVisibleTaskOptions {
   strategy?: VisibleTaskStrategy;
 }
 
-/** @public */
+/** @public @deprecated use useVisibleTask$ or useResource$, useTask$ is for running tasks as part of the initial SSR render */
 export interface UseTaskOptions {
   /**
    * - `visible`: run the effect when the element is visible.