Skip to content

Commit dc3d8fa

Browse files
docs(www): add Events and Testing plugins from Signals package to API docs (#5068)
1 parent 4116604 commit dc3d8fa

File tree

2 files changed

+143
-0
lines changed

2 files changed

+143
-0
lines changed

projects/www/src/app/reference/api-report.min.json

Lines changed: 131 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@
55
"@ngrx/store-devtools",
66
"@ngrx/signals",
77
"@ngrx/signals/entities",
8+
"@ngrx/signals/events",
89
"@ngrx/signals/rxjs-interop",
10+
"@ngrx/signals/testing",
911
"@ngrx/effects",
1012
"@ngrx/effects/testing",
1113
"@ngrx/entity",
@@ -1039,6 +1041,124 @@
10391041
}
10401042
}
10411043
},
1044+
"@ngrx/signals/events": {
1045+
"symbolNames": [
1046+
"Dispatcher",
1047+
"event_2",
1048+
"EventCreator",
1049+
"eventGroup",
1050+
"EventInstance",
1051+
"Events",
1052+
"EventScope",
1053+
"EventScopeConfig",
1054+
"injectDispatch",
1055+
"mapToScope",
1056+
"on",
1057+
"provideDispatcher",
1058+
"ReducerEvents",
1059+
"toScope",
1060+
"withEventHandlers",
1061+
"withReducer"
1062+
],
1063+
"symbols": {
1064+
"Dispatcher": {
1065+
"kind": "Class",
1066+
"name": "Dispatcher",
1067+
"canonicalReference": "@ngrx/signals/events!Dispatcher:class",
1068+
"isDeprecated": false
1069+
},
1070+
"event_2": {
1071+
"kind": "Function",
1072+
"name": "event_2",
1073+
"canonicalReference": "@ngrx/signals/events!event_2:function",
1074+
"isDeprecated": false
1075+
},
1076+
"EventCreator": {
1077+
"kind": "TypeAlias",
1078+
"name": "EventCreator",
1079+
"canonicalReference": "@ngrx/signals/events!EventCreator:type",
1080+
"isDeprecated": false
1081+
},
1082+
"eventGroup": {
1083+
"kind": "Function",
1084+
"name": "eventGroup",
1085+
"canonicalReference": "@ngrx/signals/events!eventGroup:function",
1086+
"isDeprecated": false
1087+
},
1088+
"EventInstance": {
1089+
"kind": "TypeAlias",
1090+
"name": "EventInstance",
1091+
"canonicalReference": "@ngrx/signals/events!EventInstance:type",
1092+
"isDeprecated": false
1093+
},
1094+
"Events": {
1095+
"kind": "Class",
1096+
"name": "Events",
1097+
"canonicalReference": "@ngrx/signals/events!Events:class",
1098+
"isDeprecated": false
1099+
},
1100+
"EventScope": {
1101+
"kind": "TypeAlias",
1102+
"name": "EventScope",
1103+
"canonicalReference": "@ngrx/signals/events!EventScope:type",
1104+
"isDeprecated": false
1105+
},
1106+
"EventScopeConfig": {
1107+
"kind": "TypeAlias",
1108+
"name": "EventScopeConfig",
1109+
"canonicalReference": "@ngrx/signals/events!EventScopeConfig:type",
1110+
"isDeprecated": false
1111+
},
1112+
"injectDispatch": {
1113+
"kind": "Function",
1114+
"name": "injectDispatch",
1115+
"canonicalReference": "@ngrx/signals/events!injectDispatch:function",
1116+
"isDeprecated": false
1117+
},
1118+
"mapToScope": {
1119+
"kind": "Function",
1120+
"name": "mapToScope",
1121+
"canonicalReference": "@ngrx/signals/events!mapToScope:function",
1122+
"isDeprecated": false
1123+
},
1124+
"on": {
1125+
"kind": "Function",
1126+
"name": "on",
1127+
"canonicalReference": "@ngrx/signals/events!on:function",
1128+
"isDeprecated": false
1129+
},
1130+
"provideDispatcher": {
1131+
"kind": "Function",
1132+
"name": "provideDispatcher",
1133+
"canonicalReference": "@ngrx/signals/events!provideDispatcher:function",
1134+
"isDeprecated": false
1135+
},
1136+
"ReducerEvents": {
1137+
"kind": "Class",
1138+
"name": "ReducerEvents",
1139+
"canonicalReference": "@ngrx/signals/events!ReducerEvents:class",
1140+
"isDeprecated": false
1141+
},
1142+
"toScope": {
1143+
"kind": "Function",
1144+
"name": "toScope",
1145+
"canonicalReference": "@ngrx/signals/events!toScope:function",
1146+
"isDeprecated": false
1147+
},
1148+
"withEventHandlers": {
1149+
"kind": "Function",
1150+
"name": "withEventHandlers",
1151+
"canonicalReference": "@ngrx/signals/events!withEventHandlers:function",
1152+
"isDeprecated": false
1153+
},
1154+
"withReducer": {
1155+
"kind": "Function",
1156+
"name": "withReducer",
1157+
"canonicalReference": "@ngrx/signals/events!withReducer:function",
1158+
"isDeprecated": false
1159+
}
1160+
}
1161+
},
10421162
"@ngrx/signals/rxjs-interop": {
10431163
"symbolNames": ["rxMethod", "RxMethod"],
10441164
"symbols": {
@@ -1056,6 +1176,17 @@
10561176
}
10571177
}
10581178
},
1179+
"@ngrx/signals/testing": {
1180+
"symbolNames": ["unprotected"],
1181+
"symbols": {
1182+
"unprotected": {
1183+
"kind": "Function",
1184+
"name": "unprotected",
1185+
"canonicalReference": "@ngrx/signals/testing!unprotected:function",
1186+
"isDeprecated": false
1187+
}
1188+
}
1189+
},
10591190
"@ngrx/effects": {
10601191
"symbolNames": [
10611192
"Actions",

projects/www/src/tools/extract-docs-content.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,12 +72,24 @@ const PACKAGES_TO_PARSE: ApiPackage[] = [
7272
alias: 'signals-entities',
7373
entryPoint: 'dist/modules/signals/types/ngrx-signals-entities.d.ts',
7474
},
75+
{
76+
name: '@ngrx/signals-events',
77+
rewriteName: '@ngrx/signals/events',
78+
alias: 'signals-events',
79+
entryPoint: 'dist/modules/signals/types/ngrx-signals-events.d.ts',
80+
},
7581
{
7682
name: '@ngrx/signals-rxjs-interop',
7783
rewriteName: '@ngrx/signals/rxjs-interop',
7884
alias: 'signals-rxjs-interop',
7985
entryPoint: 'dist/modules/signals/types/ngrx-signals-rxjs-interop.d.ts',
8086
},
87+
{
88+
name: '@ngrx/signals-testing',
89+
rewriteName: '@ngrx/signals/testing',
90+
alias: 'signals-testing',
91+
entryPoint: 'dist/modules/signals/types/ngrx-signals-testing.d.ts',
92+
},
8193
{
8294
name: '@ngrx/effects',
8395
alias: 'effects',

0 commit comments

Comments
 (0)