e6260829 feat(signals): add withProps base feature (#4607)

Author: web-flow

commit_message

@@ -1 +1 @@
-2528d399 feat(store): enable dispatching actions on signal changes (#4600)
+e6260829 feat(signals): add `withProps` base feature (#4607)

generated/docs/api/api-list.json

@@ -2761,6 +2761,14 @@
         "stability": "stable",
         "securityRisk": false
       },
+      {
+        "name": "withprops",
+        "title": "withProps",
+        "path": "api/signals/withProps",
+        "docType": "function",
+        "stability": "stable",
+        "securityRisk": false
+      },
       {
         "name": "withstate",
         "title": "withState",
@@ -2800,14 +2808,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",
@@ -2832,6 +2832,14 @@
         "stability": "stable",
         "securityRisk": false
       },
+      {
+        "name": "entityprops",
+        "title": "EntityProps",
+        "path": "api/signals/entities/EntityProps",
+        "docType": "type-alias",
+        "stability": "stable",
+        "securityRisk": false
+      },
       {
         "name": "entitystate",
         "title": "EntityState",
@@ -2841,9 +2849,9 @@
         "securityRisk": false
       },
       {
-        "name": "namedentitycomputed",
-        "title": "NamedEntityComputed",
-        "path": "api/signals/entities/NamedEntityComputed",
+        "name": "namedentityprops",
+        "title": "NamedEntityProps",
+        "path": "api/signals/entities/NamedEntityProps",
         "docType": "type-alias",
         "stability": "stable",
         "securityRisk": false

generated/docs/api/data/EntityCollection.json

@@ -1,5 +1,5 @@
 {
   "id": "api/signals/EmptyFeatureResult",
   "title": "EmptyFeatureResult",
-  "contents": "\n\n<article>\n  <div class=\"github-links\">\n  <a href=\"https://github.com/ngrx/platform/edit/main/modules/signals/src/signal-store-models.ts?message=docs(signals)%3A%20describe%20your%20change...#L39-L40\" 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/19.0.0-beta.0/modules/signals/src/signal-store-models.ts#L39-L40\" 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/EmptyFeatureResult\", \"name\": \"EmptyFeatureResult\" } }\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=\"emptyfeatureresult\">EmptyFeatureResult<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/signals/EmptyFeatureResult#emptyfeatureresult\"><i class=\"material-icons\">link</i></a></h1>\n    <label class=\"api-type-label type-alias\">type-alias</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  <section class=\"type-alias-overview\">\n    <code-example language=\"ts\" hidecopy=\"true\">\n    <a href=\"api/signals/type\" class=\"code-anchor\">type</a> <a href=\"api/signals/EmptyFeatureResult\" class=\"code-anchor\">EmptyFeatureResult</a> = {\n    state: {};\n    computed: {};\n    <a href=\"api/data/EntityCollectionReducerMethods#methods\" class=\"code-anchor\">methods</a>: {};\n};\n    </code-example>\n  </section>\n\n  \n\n  \n  \n\n  \n\n\n  </div>\n</article>\n\n<!-- links to this doc:\n - api/signals\n - api/signals/entities/withEntities\n - api/signals/signalStore\n - api/signals/signalStoreFeature-0\n - api/signals/withHooks\n-->\n<!-- links from this doc:\n - /api\n - api/data/EntityCollectionReducerMethods#methods\n - api/signals\n - api/signals/EmptyFeatureResult#emptyfeatureresult\n - api/signals/type\n - https://github.com/ngrx/platform/edit/main/modules/signals/src/signal-store-models.ts?message=docs(signals)%3A%20describe%20your%20change...#L39-L40\n - https://github.com/ngrx/platform/tree/19.0.0-beta.0/modules/signals/src/signal-store-models.ts#L39-L40\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-models.ts?message=docs(signals)%3A%20describe%20your%20change...#L39-L40\" 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/19.0.0-beta.0/modules/signals/src/signal-store-models.ts#L39-L40\" 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/EmptyFeatureResult\", \"name\": \"EmptyFeatureResult\" } }\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=\"emptyfeatureresult\">EmptyFeatureResult<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/signals/EmptyFeatureResult#emptyfeatureresult\"><i class=\"material-icons\">link</i></a></h1>\n    <label class=\"api-type-label type-alias\">type-alias</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  <section class=\"type-alias-overview\">\n    <code-example language=\"ts\" hidecopy=\"true\">\n    <a href=\"api/signals/type\" class=\"code-anchor\">type</a> <a href=\"api/signals/EmptyFeatureResult\" class=\"code-anchor\">EmptyFeatureResult</a> = {\n    state: {};\n    <a href=\"api/store/props\" class=\"code-anchor\">props</a>: {};\n    <a href=\"api/data/EntityCollectionReducerMethods#methods\" class=\"code-anchor\">methods</a>: {};\n};\n    </code-example>\n  </section>\n\n  \n\n  \n  \n\n  \n\n\n  </div>\n</article>\n\n<!-- links to this doc:\n - api/signals\n - api/signals/entities/withEntities\n - api/signals/signalStore\n - api/signals/signalStoreFeature-0\n - api/signals/withHooks\n-->\n<!-- links from this doc:\n - /api\n - api/data/EntityCollectionReducerMethods#methods\n - api/signals\n - api/signals/EmptyFeatureResult#emptyfeatureresult\n - api/signals/type\n - api/store/props\n - https://github.com/ngrx/platform/edit/main/modules/signals/src/signal-store-models.ts?message=docs(signals)%3A%20describe%20your%20change...#L39-L40\n - https://github.com/ngrx/platform/tree/19.0.0-beta.0/modules/signals/src/signal-store-models.ts#L39-L40\n-->"
 }

generated/docs/api/data/EntityCollectionReducerMethods.json

@@ -1,5 +1,5 @@
 {
   "id": "api/signals/SignalStoreFeature-1",
   "title": "SignalStoreFeature",
-  "contents": "\n\n<article>\n  <div class=\"github-links\">\n  <a href=\"https://github.com/ngrx/platform/edit/main/modules/signals/src/signal-store-models.ts?message=docs(signals)%3A%20describe%20your%20change...#L41-L47\" 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/19.0.0-beta.0/modules/signals/src/signal-store-models.ts#L41-L47\" 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/SignalStoreFeature-1\", \"name\": \"SignalStoreFeature\" } }\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=\"signalstorefeature\">SignalStoreFeature<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/signals/SignalStoreFeature-1#signalstorefeature\"><i class=\"material-icons\">link</i></a></h1>\n    <label class=\"api-type-label type-alias\">type-alias</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  <section class=\"type-alias-overview\">\n    <code-example language=\"ts\" hidecopy=\"true\">\n    <a href=\"api/signals/type\" class=\"code-anchor\">type</a> <a href=\"api/signals/SignalStoreFeature-1\" class=\"code-anchor\">SignalStoreFeature</a>&#x3C;Input extends <a href=\"api/signals/SignalStoreFeatureResult\" class=\"code-anchor\">SignalStoreFeatureResult</a> = <a href=\"api/signals/SignalStoreFeatureResult\" class=\"code-anchor\">SignalStoreFeatureResult</a>, Output extends <a href=\"api/signals/SignalStoreFeatureResult\" class=\"code-anchor\">SignalStoreFeatureResult</a> = <a href=\"api/signals/SignalStoreFeatureResult\" class=\"code-anchor\">SignalStoreFeatureResult</a>> = (store: InnerSignalStore&#x3C;Input['state'], Input['computed'], Input['<a href=\"api/data/EntityCollectionReducerMethods#methods\" class=\"code-anchor\">methods</a>']>) => InnerSignalStore&#x3C;Output['state'], Output['computed'], Output['<a href=\"api/data/EntityCollectionReducerMethods#methods\" class=\"code-anchor\">methods</a>']>;\n    </code-example>\n  </section>\n\n  \n\n  \n  \n\n  \n\n\n  </div>\n</article>\n\n<!-- links to this doc:\n - api/signals\n - api/signals/entities/withEntities\n - api/signals/signalStore\n - api/signals/signalStoreFeature-0\n - api/signals/withComputed\n - api/signals/withHooks\n - api/signals/withMethods\n - api/signals/withState\n-->\n<!-- links from this doc:\n - /api\n - api/data/EntityCollectionReducerMethods#methods\n - api/signals\n - api/signals/SignalStoreFeature-1#signalstorefeature\n - api/signals/SignalStoreFeatureResult\n - api/signals/type\n - https://github.com/ngrx/platform/edit/main/modules/signals/src/signal-store-models.ts?message=docs(signals)%3A%20describe%20your%20change...#L41-L47\n - https://github.com/ngrx/platform/tree/19.0.0-beta.0/modules/signals/src/signal-store-models.ts#L41-L47\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-models.ts?message=docs(signals)%3A%20describe%20your%20change...#L41-L47\" 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/19.0.0-beta.0/modules/signals/src/signal-store-models.ts#L41-L47\" 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/SignalStoreFeature-1\", \"name\": \"SignalStoreFeature\" } }\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=\"signalstorefeature\">SignalStoreFeature<a title=\"Link to this heading\" class=\"header-link\" aria-hidden=\"true\" href=\"api/signals/SignalStoreFeature-1#signalstorefeature\"><i class=\"material-icons\">link</i></a></h1>\n    <label class=\"api-type-label type-alias\">type-alias</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  <section class=\"type-alias-overview\">\n    <code-example language=\"ts\" hidecopy=\"true\">\n    <a href=\"api/signals/type\" class=\"code-anchor\">type</a> <a href=\"api/signals/SignalStoreFeature-1\" class=\"code-anchor\">SignalStoreFeature</a>&#x3C;Input extends <a href=\"api/signals/SignalStoreFeatureResult\" class=\"code-anchor\">SignalStoreFeatureResult</a> = <a href=\"api/signals/SignalStoreFeatureResult\" class=\"code-anchor\">SignalStoreFeatureResult</a>, Output extends <a href=\"api/signals/SignalStoreFeatureResult\" class=\"code-anchor\">SignalStoreFeatureResult</a> = <a href=\"api/signals/SignalStoreFeatureResult\" class=\"code-anchor\">SignalStoreFeatureResult</a>> = (store: InnerSignalStore&#x3C;Input['state'], Input['<a href=\"api/store/props\" class=\"code-anchor\">props</a>'], Input['<a href=\"api/data/EntityCollectionReducerMethods#methods\" class=\"code-anchor\">methods</a>']>) => InnerSignalStore&#x3C;Output['state'], Output['<a href=\"api/store/props\" class=\"code-anchor\">props</a>'], Output['<a href=\"api/data/EntityCollectionReducerMethods#methods\" class=\"code-anchor\">methods</a>']>;\n    </code-example>\n  </section>\n\n  \n\n  \n  \n\n  \n\n\n  </div>\n</article>\n\n<!-- links to this doc:\n - api/signals\n - api/signals/entities/withEntities\n - api/signals/signalStore\n - api/signals/signalStoreFeature-0\n - api/signals/withComputed\n - api/signals/withHooks\n - api/signals/withMethods\n - api/signals/withProps\n - api/signals/withState\n-->\n<!-- links from this doc:\n - /api\n - api/data/EntityCollectionReducerMethods#methods\n - api/signals\n - api/signals/SignalStoreFeature-1#signalstorefeature\n - api/signals/SignalStoreFeatureResult\n - api/signals/type\n - api/store/props\n - https://github.com/ngrx/platform/edit/main/modules/signals/src/signal-store-models.ts?message=docs(signals)%3A%20describe%20your%20change...#L41-L47\n - https://github.com/ngrx/platform/tree/19.0.0-beta.0/modules/signals/src/signal-store-models.ts#L41-L47\n-->"
 }