889b2561 docs(signals): add note about TS issue for custom features w…

…ith static input (#4436)

commit_message

@@ -1 +1 @@
-87e3be82 feat(signals): add EntityComputed to the public API (#4437)
+889b2561 docs(signals): add note about TS issue for custom features with static input (#4436)

generated/docs/api/api-list.json

@@ -2728,14 +2728,6 @@
         "stability": "stable",
         "securityRisk": false
       },
-      {
-        "name": "entitycomputed",
-        "title": "EntityComputed",
-        "path": "api/signals/entities/EntityComputed",
-        "docType": "type-alias",
-        "stability": "stable",
-        "securityRisk": false
-      },
       {
         "name": "entityconfig",
         "title": "entityConfig",
@@ -2768,14 +2760,6 @@
         "stability": "stable",
         "securityRisk": false
       },
-      {
-        "name": "namedentitycomputed",
-        "title": "NamedEntityComputed",
-        "path": "api/signals/entities/NamedEntityComputed",
-        "docType": "type-alias",
-        "stability": "stable",
-        "securityRisk": false
-      },
       {
         "name": "namedentitystate",
         "title": "NamedEntityState",

generated/docs/api/signals/type.json

@@ -1,5 +1,5 @@
 {
   "id": "api/signals/type",
   "title": "type",
-  "contents": "\n\n<article>\n  <div class=\"github-links\">\n  <a href=\"https://github.com/ngrx/platform/edit/main/modules/signals/src/signal-store-feature.ts?message=docs(signals)%3A%20describe%20your%20change...#L383-L386\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n  <a href=\"https://github.com/ngrx/platform/tree/18.0.1/modules/signals/src/signal-store-feature.ts#L383-L386\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n  <div class=\"breadcrumb\">\n    <script type=\"application/ld+json\">\n      {\n        \"@context\": \"http://schema.org\",\n        \"@type\": \"BreadcrumbList\",\n        \"itemListElement\": [\n          { \"@type\": \"ListItem\", \"position\": 1, \"item\": { \"@id\": \"https://ngrx.io//api\", \"name\": \"API\" } },\n          { \"@type\": \"ListItem\", \"position\": 2, \"item\": { \"@id\": \"https://ngrx.io/api/signals\", \"name\": \"@ngrx/signals\" } },\n          { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://ngrx.io/api/signals/type\", \"name\": \"type\" } }\n        ]\n      }\n    </script>\n      <a href=\"/api\">API</a> > <a href=\"api/signals\">@ngrx/signals</a>\n  </div>\n  \n  <header class=\"api-header\">\n    <h1 id=\"type\">type<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/signals/type#type\"><i class=\"material-icons\">link</i></a></h1>\n    <label class=\"api-type-label function\">function</label>\n    \n    \n    \n  </header>\n  \n  <aio-toc class=\"embedded\"></aio-toc>\n\n  <div class=\"api-body\">\n    \n  <section class=\"short-description\">\n    \n    \n  </section>\n  \n  \n  \n\n  \n\n<code-example language=\"ts\" hidecopy=\"true\" linenums=\"false\" class=\"no-box api-heading\"> <span class=\"member-name\"><a href=\"api/signals/type\" class=\"code-anchor\">type</a></span>&#x3C;T>(): T</code-example>\n\n\n\n<h4 class=\"no-anchor\" id=\"parameters\">Parameters</h4>\n<p>There are no parameters.</p>\n\n\n<h4 class=\"no-anchor\" id=\"returns\">Returns</h4>\n<p><code>T</code></p>\n\n\n\n\n\n\n\n\n\n  \n\n  \n\n\n\n  \n\n\n  </div>\n</article>\n\n<!-- links to this doc:\n - api/component-store/Projector\n - api/component-store/SelectorResults\n - api/component/LetDirective\n - api/data/ChangeSetItem\n - api/data/ChangeStateMap\n - api/data/ClearCollections\n - api/data/EntityAction\n - api/data/EntityCacheSelector\n - api/data/EntityCollectionReducer\n - api/data/EntityFilterFn\n - api/data/HttpMethods\n - api/data/LoadCollections\n - api/data/MergeQuerySet\n - api/data/SaveEntities\n - api/data/SaveEntitiesCancel\n - api/data/SaveEntitiesCanceled\n - api/data/SaveEntitiesError\n - api/data/SaveEntitiesSuccess\n - api/data/SetEntityCache\n - api/effects/EffectsErrorHandler\n - api/effects/EffectsMetadata\n - api/effects/FunctionalEffect\n - api/effects/OnInitEffects\n - api/entity/Comparer\n - api/entity/EntityMap\n - api/entity/EntityMapOne\n - api/entity/IdSelector\n - api/entity/Predicate\n - api/entity/Update\n - api/router-store/RouterAction\n - api/router-store/RouterCancelAction-0\n - api/router-store/RouterCancelPayload\n - api/router-store/RouterErrorAction-0\n - api/router-store/RouterErrorPayload\n - api/router-store/RouterNavigatedAction-0\n - api/router-store/RouterNavigatedPayload\n - api/router-store/RouterNavigationAction-0\n - api/router-store/RouterNavigationPayload\n - api/router-store/RouterReducerState\n - api/router-store/RouterRequestAction-0\n - api/router-store/RouterRequestPayload\n - api/router-store/StateKeyOrSelector\n - api/router-store/StoreRouterConnectingModule\n - api/router-store/data-persistence/fetch\n - api/router-store/data-persistence/navigation\n - api/router-store/data-persistence/optimisticUpdate\n - api/router-store/data-persistence/pessimisticUpdate\n - api/signals\n - api/signals/DeepSignal\n - api/signals/PartialStateUpdater\n - api/signals/SignalState-1\n - api/signals/SignalStoreFeature-1\n - api/signals/StateSource\n - api/signals/entities/EntityComputed\n - api/signals/entities/EntityId\n - api/signals/entities/EntityMap\n - api/signals/entities/EntityState\n - api/signals/entities/NamedEntityComputed\n - api/signals/entities/NamedEntityState\n - api/signals/entities/SelectEntityId\n - api/store-devtools/StoreDevtoolsOptions\n - api/store/Action\n - api/store/ActionCreator\n - api/store/ActionReducerMap\n - api/store/ActionType\n - api/store/Creator\n - api/store/DefaultProjectorFn\n - api/store/FunctionWithParametersType\n - api/store/MemoizeFn\n - api/store/MemoizedProjection\n - api/store/MetaReducer\n - api/store/NotAllowedCheck\n - api/store/Selector\n - api/store/SelectorWithProps\n - api/store/createAction\n - api/store/createActionGroup\n - api/store/createFeature\n - contributing\n - guide/component-store/read\n - guide/component-store/usage\n - guide/component/let\n - guide/data/entity-actions\n - guide/data/entity-metadata\n - guide/effects\n - guide/effects/lifecycle\n - guide/effects/operators\n - guide/effects/testing\n - guide/entity/adapter\n - guide/eslint-plugin/rules/on-function-explicit-return-type\n - guide/eslint-plugin/rules/prefer-action-creator\n - guide/eslint-plugin/rules/prefer-action-creator-in-dispatch\n - guide/eslint-plugin/rules/prefer-inline-action-props\n - guide/eslint-plugin/rules/use-effects-lifecycle-interface\n - guide/migration/v15\n - guide/migration/v16\n - guide/migration/v17\n - guide/migration/v4\n - guide/migration/v7\n - guide/migration/v8\n - guide/router-store/selectors\n - guide/signals/faq\n - guide/signals/rxjs-integration\n - guide/signals/signal-state\n - guide/signals/signal-store\n - guide/signals/signal-store/custom-store-features\n - guide/signals/signal-store/entity-management\n - guide/store/action-groups\n - guide/store/actions\n - guide/store/selectors\n - guide/store/testing\n-->\n<!-- links from this doc:\n - /api\n - api/signals\n - api/signals/type#type\n - https://github.com/ngrx/platform/edit/main/modules/signals/src/signal-store-feature.ts?message=docs(signals)%3A%20describe%20your%20change...#L383-L386\n - https://github.com/ngrx/platform/tree/18.0.1/modules/signals/src/signal-store-feature.ts#L383-L386\n-->"
+  "contents": "\n\n<article>\n  <div class=\"github-links\">\n  <a href=\"https://github.com/ngrx/platform/edit/main/modules/signals/src/signal-store-feature.ts?message=docs(signals)%3A%20describe%20your%20change...#L383-L386\" aria-label=\"Suggest Edits\" title=\"Suggest Edits\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">mode_edit</i></a>\n  <a href=\"https://github.com/ngrx/platform/tree/18.0.1/modules/signals/src/signal-store-feature.ts#L383-L386\" aria-label=\"View Source\" title=\"View Source\"><i class=\"material-icons\" aria-hidden=\"true\" role=\"img\">code</i></a>\n</div>\n  <div class=\"breadcrumb\">\n    <script type=\"application/ld+json\">\n      {\n        \"@context\": \"http://schema.org\",\n        \"@type\": \"BreadcrumbList\",\n        \"itemListElement\": [\n          { \"@type\": \"ListItem\", \"position\": 1, \"item\": { \"@id\": \"https://ngrx.io//api\", \"name\": \"API\" } },\n          { \"@type\": \"ListItem\", \"position\": 2, \"item\": { \"@id\": \"https://ngrx.io/api/signals\", \"name\": \"@ngrx/signals\" } },\n          { \"@type\": \"ListItem\", \"position\": 3, \"item\": { \"@id\": \"https://ngrx.io/api/signals/type\", \"name\": \"type\" } }\n        ]\n      }\n    </script>\n      <a href=\"/api\">API</a> > <a href=\"api/signals\">@ngrx/signals</a>\n  </div>\n  \n  <header class=\"api-header\">\n    <h1 id=\"type\">type<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/signals/type#type\"><i class=\"material-icons\">link</i></a></h1>\n    <label class=\"api-type-label function\">function</label>\n    \n    \n    \n  </header>\n  \n  <aio-toc class=\"embedded\"></aio-toc>\n\n  <div class=\"api-body\">\n    \n  <section class=\"short-description\">\n    \n    \n  </section>\n  \n  \n  \n\n  \n\n<code-example language=\"ts\" hidecopy=\"true\" linenums=\"false\" class=\"no-box api-heading\"> <span class=\"member-name\"><a href=\"api/signals/type\" class=\"code-anchor\">type</a></span>&#x3C;T>(): T</code-example>\n\n\n\n<h4 class=\"no-anchor\" id=\"parameters\">Parameters</h4>\n<p>There are no parameters.</p>\n\n\n<h4 class=\"no-anchor\" id=\"returns\">Returns</h4>\n<p><code>T</code></p>\n\n\n\n\n\n\n\n\n\n  \n\n  \n\n\n\n  \n\n\n  </div>\n</article>\n\n<!-- links to this doc:\n - api/component-store/Projector\n - api/component-store/SelectorResults\n - api/component/LetDirective\n - api/data/ChangeSetItem\n - api/data/ChangeStateMap\n - api/data/ClearCollections\n - api/data/EntityAction\n - api/data/EntityCacheSelector\n - api/data/EntityCollectionReducer\n - api/data/EntityFilterFn\n - api/data/HttpMethods\n - api/data/LoadCollections\n - api/data/MergeQuerySet\n - api/data/SaveEntities\n - api/data/SaveEntitiesCancel\n - api/data/SaveEntitiesCanceled\n - api/data/SaveEntitiesError\n - api/data/SaveEntitiesSuccess\n - api/data/SetEntityCache\n - api/effects/EffectsErrorHandler\n - api/effects/EffectsMetadata\n - api/effects/FunctionalEffect\n - api/effects/OnInitEffects\n - api/entity/Comparer\n - api/entity/EntityMap\n - api/entity/EntityMapOne\n - api/entity/IdSelector\n - api/entity/Predicate\n - api/entity/Update\n - api/router-store/RouterAction\n - api/router-store/RouterCancelAction-0\n - api/router-store/RouterCancelPayload\n - api/router-store/RouterErrorAction-0\n - api/router-store/RouterErrorPayload\n - api/router-store/RouterNavigatedAction-0\n - api/router-store/RouterNavigatedPayload\n - api/router-store/RouterNavigationAction-0\n - api/router-store/RouterNavigationPayload\n - api/router-store/RouterReducerState\n - api/router-store/RouterRequestAction-0\n - api/router-store/RouterRequestPayload\n - api/router-store/StateKeyOrSelector\n - api/router-store/StoreRouterConnectingModule\n - api/router-store/data-persistence/fetch\n - api/router-store/data-persistence/navigation\n - api/router-store/data-persistence/optimisticUpdate\n - api/router-store/data-persistence/pessimisticUpdate\n - api/signals\n - api/signals/DeepSignal\n - api/signals/PartialStateUpdater\n - api/signals/SignalState-1\n - api/signals/SignalStoreFeature-1\n - api/signals/StateSource\n - api/signals/entities/EntityId\n - api/signals/entities/EntityMap\n - api/signals/entities/EntityState\n - api/signals/entities/NamedEntityState\n - api/signals/entities/SelectEntityId\n - api/store-devtools/StoreDevtoolsOptions\n - api/store/Action\n - api/store/ActionCreator\n - api/store/ActionReducerMap\n - api/store/ActionType\n - api/store/Creator\n - api/store/DefaultProjectorFn\n - api/store/FunctionWithParametersType\n - api/store/MemoizeFn\n - api/store/MemoizedProjection\n - api/store/MetaReducer\n - api/store/NotAllowedCheck\n - api/store/Selector\n - api/store/SelectorWithProps\n - api/store/createAction\n - api/store/createActionGroup\n - api/store/createFeature\n - contributing\n - guide/component-store/read\n - guide/component-store/usage\n - guide/component/let\n - guide/data/entity-actions\n - guide/data/entity-metadata\n - guide/effects\n - guide/effects/lifecycle\n - guide/effects/operators\n - guide/effects/testing\n - guide/entity/adapter\n - guide/eslint-plugin/rules/on-function-explicit-return-type\n - guide/eslint-plugin/rules/prefer-action-creator\n - guide/eslint-plugin/rules/prefer-action-creator-in-dispatch\n - guide/eslint-plugin/rules/prefer-inline-action-props\n - guide/eslint-plugin/rules/use-effects-lifecycle-interface\n - guide/migration/v15\n - guide/migration/v16\n - guide/migration/v17\n - guide/migration/v4\n - guide/migration/v7\n - guide/migration/v8\n - guide/router-store/selectors\n - guide/signals/faq\n - guide/signals/rxjs-integration\n - guide/signals/signal-state\n - guide/signals/signal-store\n - guide/signals/signal-store/custom-store-features\n - guide/signals/signal-store/entity-management\n - guide/store/action-groups\n - guide/store/actions\n - guide/store/selectors\n - guide/store/testing\n-->\n<!-- links from this doc:\n - /api\n - api/signals\n - api/signals/type#type\n - https://github.com/ngrx/platform/edit/main/modules/signals/src/signal-store-feature.ts?message=docs(signals)%3A%20describe%20your%20change...#L383-L386\n - https://github.com/ngrx/platform/tree/18.0.1/modules/signals/src/signal-store-feature.ts#L383-L386\n-->"
 }