@rxap/ngx-pub-sub 19.0.1-dev.4 → 19.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (90) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/README.md +24 -25
  3. package/compodoc/changelog.html +9 -0
  4. package/compodoc/index.html +26 -17
  5. package/compodoc/js/search/search_index.js +2 -2
  6. package/compodoc/miscellaneous/variables.html +26 -0
  7. package/compodoc/properties.html +4 -1
  8. package/docs/documentation.json +191 -706
  9. package/docs/html/assets/hierarchy.js +1 -0
  10. package/docs/{assets → html/assets}/highlight.css +13 -6
  11. package/docs/html/assets/icons.js +18 -0
  12. package/docs/html/assets/icons.svg +1 -0
  13. package/docs/{assets → html/assets}/main.js +5 -4
  14. package/docs/html/assets/navigation.js +1 -0
  15. package/docs/html/assets/search.js +1 -0
  16. package/docs/html/assets/style.css +1611 -0
  17. package/docs/html/classes/MessageMetaData.html +13 -0
  18. package/docs/html/classes/PubSubService.html +27 -0
  19. package/docs/html/functions/ProvidePubSub.html +1 -0
  20. package/docs/html/functions/withDisableCache.html +1 -0
  21. package/docs/html/functions/withDisableGarbageCollector.html +1 -0
  22. package/docs/html/functions/withGarbageCollectorInterval.html +1 -0
  23. package/docs/html/functions/withMaxCacheSize.html +1 -0
  24. package/docs/html/hierarchy.html +1 -0
  25. package/docs/html/index.html +33 -0
  26. package/docs/html/interfaces/CachedPubSubMessage.html +6 -0
  27. package/docs/html/interfaces/PubSubMessage.html +5 -0
  28. package/docs/html/modules.html +1 -0
  29. package/docs/html/variables/RXAP_PUB_SUB_CACHE_SIZE.html +1 -0
  30. package/docs/html/variables/RXAP_PUB_SUB_DISABLE_CACHE.html +1 -0
  31. package/docs/html/variables/RXAP_PUB_SUB_DISABLE_GARBAGE_COLLECTOR.html +1 -0
  32. package/docs/html/variables/RXAP_PUB_SUB_GARBAGE_COLLECTOR_INTERVAL.html +1 -0
  33. package/docs/html/variables/RXAP_TOPICS.html +4 -0
  34. package/docs/markdown/README.md +37 -0
  35. package/docs/markdown/classes/MessageMetaData.md +105 -0
  36. package/docs/markdown/classes/PubSubService.md +242 -0
  37. package/docs/markdown/functions/ProvidePubSub.md +21 -0
  38. package/docs/markdown/functions/withDisableCache.md +15 -0
  39. package/docs/markdown/functions/withDisableGarbageCollector.md +15 -0
  40. package/docs/markdown/functions/withGarbageCollectorInterval.md +21 -0
  41. package/docs/markdown/functions/withMaxCacheSize.md +21 -0
  42. package/docs/markdown/globals.md +31 -0
  43. package/docs/markdown/interfaces/CachedPubSubMessage.md +53 -0
  44. package/docs/markdown/interfaces/PubSubMessage.md +37 -0
  45. package/docs/markdown/variables/RXAP_PUB_SUB_CACHE_SIZE.md +11 -0
  46. package/docs/markdown/variables/RXAP_PUB_SUB_DISABLE_CACHE.md +11 -0
  47. package/docs/markdown/variables/RXAP_PUB_SUB_DISABLE_GARBAGE_COLLECTOR.md +11 -0
  48. package/docs/markdown/variables/RXAP_PUB_SUB_GARBAGE_COLLECTOR_INTERVAL.md +11 -0
  49. package/docs/markdown/variables/RXAP_TOPICS.md +82 -0
  50. package/docs/wiki/Class.MessageMetaData.md +101 -0
  51. package/docs/wiki/Class.PubSubService.md +238 -0
  52. package/docs/wiki/Function.ProvidePubSub.md +17 -0
  53. package/docs/wiki/Function.withDisableCache.md +11 -0
  54. package/docs/wiki/Function.withDisableGarbageCollector.md +11 -0
  55. package/docs/wiki/Function.withGarbageCollectorInterval.md +17 -0
  56. package/docs/wiki/Function.withMaxCacheSize.md +17 -0
  57. package/docs/wiki/Home.md +33 -0
  58. package/docs/wiki/Interface.CachedPubSubMessage.md +49 -0
  59. package/docs/wiki/Interface.PubSubMessage.md +33 -0
  60. package/docs/wiki/Variable.RXAP_PUB_SUB_CACHE_SIZE.md +7 -0
  61. package/docs/wiki/Variable.RXAP_PUB_SUB_DISABLE_CACHE.md +7 -0
  62. package/docs/wiki/Variable.RXAP_PUB_SUB_DISABLE_GARBAGE_COLLECTOR.md +7 -0
  63. package/docs/wiki/Variable.RXAP_PUB_SUB_GARBAGE_COLLECTOR_INTERVAL.md +7 -0
  64. package/docs/wiki/Variable.RXAP_TOPICS.md +78 -0
  65. package/docs/wiki/_Sidebar.md +27 -0
  66. package/docs/wiki/globals.md +27 -0
  67. package/package.json +4 -2
  68. package/docs/assets/icons.js +0 -15
  69. package/docs/assets/icons.svg +0 -1
  70. package/docs/assets/navigation.js +0 -1
  71. package/docs/assets/search.js +0 -1
  72. package/docs/assets/style.css +0 -1412
  73. package/docs/classes/MessageMetaData.html +0 -25
  74. package/docs/classes/PubSubService.html +0 -36
  75. package/docs/functions/ProvidePubSub.html +0 -1
  76. package/docs/functions/withDisableCache.html +0 -1
  77. package/docs/functions/withDisableGarbageCollector.html +0 -1
  78. package/docs/functions/withGarbageCollectorInterval.html +0 -1
  79. package/docs/functions/withMaxCacheSize.html +0 -1
  80. package/docs/hierarchy.html +0 -1
  81. package/docs/index.html +0 -25
  82. package/docs/interfaces/CachedPubSubMessage.html +0 -6
  83. package/docs/interfaces/PubSubMessage.html +0 -5
  84. package/docs/modules.html +0 -15
  85. package/docs/variables/RXAP_PUB_SUB_CACHE_SIZE.html +0 -1
  86. package/docs/variables/RXAP_PUB_SUB_DISABLE_CACHE.html +0 -1
  87. package/docs/variables/RXAP_PUB_SUB_DISABLE_GARBAGE_COLLECTOR.html +0 -1
  88. package/docs/variables/RXAP_PUB_SUB_GARBAGE_COLLECTOR_INTERVAL.html +0 -1
  89. package/docs/variables/RXAP_TOPICS.html +0 -4
  90. /package/docs/{.nojekyll → html/.nojekyll} +0 -0
@@ -0,0 +1,21 @@
1
+ [**@rxap/ngx-pub-sub**](../README.md)
2
+
3
+ ***
4
+
5
+ [@rxap/ngx-pub-sub](../globals.md) / withGarbageCollectorInterval
6
+
7
+ # Function: withGarbageCollectorInterval()
8
+
9
+ > **withGarbageCollectorInterval**(`interval`): `Provider`
10
+
11
+ Defined in: [provide.ts:44](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/provide.ts#L44)
12
+
13
+ ## Parameters
14
+
15
+ ### interval
16
+
17
+ `number`
18
+
19
+ ## Returns
20
+
21
+ `Provider`
@@ -0,0 +1,21 @@
1
+ [**@rxap/ngx-pub-sub**](../README.md)
2
+
3
+ ***
4
+
5
+ [@rxap/ngx-pub-sub](../globals.md) / withMaxCacheSize
6
+
7
+ # Function: withMaxCacheSize()
8
+
9
+ > **withMaxCacheSize**(`size`): `Provider`
10
+
11
+ Defined in: [provide.ts:37](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/provide.ts#L37)
12
+
13
+ ## Parameters
14
+
15
+ ### size
16
+
17
+ `number`
18
+
19
+ ## Returns
20
+
21
+ `Provider`
@@ -0,0 +1,31 @@
1
+ [**@rxap/ngx-pub-sub**](README.md)
2
+
3
+ ***
4
+
5
+ # @rxap/ngx-pub-sub
6
+
7
+ ## Classes
8
+
9
+ - [MessageMetaData](classes/MessageMetaData.md)
10
+ - [PubSubService](classes/PubSubService.md)
11
+
12
+ ## Interfaces
13
+
14
+ - [CachedPubSubMessage](interfaces/CachedPubSubMessage.md)
15
+ - [PubSubMessage](interfaces/PubSubMessage.md)
16
+
17
+ ## Variables
18
+
19
+ - [RXAP\_PUB\_SUB\_CACHE\_SIZE](variables/RXAP_PUB_SUB_CACHE_SIZE.md)
20
+ - [RXAP\_PUB\_SUB\_DISABLE\_CACHE](variables/RXAP_PUB_SUB_DISABLE_CACHE.md)
21
+ - [RXAP\_PUB\_SUB\_DISABLE\_GARBAGE\_COLLECTOR](variables/RXAP_PUB_SUB_DISABLE_GARBAGE_COLLECTOR.md)
22
+ - [RXAP\_PUB\_SUB\_GARBAGE\_COLLECTOR\_INTERVAL](variables/RXAP_PUB_SUB_GARBAGE_COLLECTOR_INTERVAL.md)
23
+ - [RXAP\_TOPICS](variables/RXAP_TOPICS.md)
24
+
25
+ ## Functions
26
+
27
+ - [ProvidePubSub](functions/ProvidePubSub.md)
28
+ - [withDisableCache](functions/withDisableCache.md)
29
+ - [withDisableGarbageCollector](functions/withDisableGarbageCollector.md)
30
+ - [withGarbageCollectorInterval](functions/withGarbageCollectorInterval.md)
31
+ - [withMaxCacheSize](functions/withMaxCacheSize.md)
@@ -0,0 +1,53 @@
1
+ [**@rxap/ngx-pub-sub**](../README.md)
2
+
3
+ ***
4
+
5
+ [@rxap/ngx-pub-sub](../globals.md) / CachedPubSubMessage
6
+
7
+ # Interface: CachedPubSubMessage\<T\>
8
+
9
+ Defined in: [pub-sub-message.ts:15](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/pub-sub-message.ts#L15)
10
+
11
+ ## Extends
12
+
13
+ - [`PubSubMessage`](PubSubMessage.md)\<`T`\>
14
+
15
+ ## Type Parameters
16
+
17
+ • **T** = `unknown`
18
+
19
+ ## Properties
20
+
21
+ ### metadata
22
+
23
+ > **metadata**: [`MessageMetaData`](../classes/MessageMetaData.md)\<`T`\>
24
+
25
+ Defined in: [pub-sub-message.ts:12](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/pub-sub-message.ts#L12)
26
+
27
+ Full message metadata.
28
+
29
+ #### Inherited from
30
+
31
+ [`PubSubMessage`](PubSubMessage.md).[`metadata`](PubSubMessage.md#metadata)
32
+
33
+ ***
34
+
35
+ ### retention?
36
+
37
+ > `optional` **retention**: `number`
38
+
39
+ Defined in: [pub-sub-message.ts:16](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/pub-sub-message.ts#L16)
40
+
41
+ ***
42
+
43
+ ### topic
44
+
45
+ > **topic**: `string`
46
+
47
+ Defined in: [pub-sub-message.ts:7](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/pub-sub-message.ts#L7)
48
+
49
+ Key to identify message.
50
+
51
+ #### Inherited from
52
+
53
+ [`PubSubMessage`](PubSubMessage.md).[`topic`](PubSubMessage.md#topic)
@@ -0,0 +1,37 @@
1
+ [**@rxap/ngx-pub-sub**](../README.md)
2
+
3
+ ***
4
+
5
+ [@rxap/ngx-pub-sub](../globals.md) / PubSubMessage
6
+
7
+ # Interface: PubSubMessage\<T\>
8
+
9
+ Defined in: [pub-sub-message.ts:3](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/pub-sub-message.ts#L3)
10
+
11
+ ## Extended by
12
+
13
+ - [`CachedPubSubMessage`](CachedPubSubMessage.md)
14
+
15
+ ## Type Parameters
16
+
17
+ • **T** = `unknown`
18
+
19
+ ## Properties
20
+
21
+ ### metadata
22
+
23
+ > **metadata**: [`MessageMetaData`](../classes/MessageMetaData.md)\<`T`\>
24
+
25
+ Defined in: [pub-sub-message.ts:12](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/pub-sub-message.ts#L12)
26
+
27
+ Full message metadata.
28
+
29
+ ***
30
+
31
+ ### topic
32
+
33
+ > **topic**: `string`
34
+
35
+ Defined in: [pub-sub-message.ts:7](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/pub-sub-message.ts#L7)
36
+
37
+ Key to identify message.
@@ -0,0 +1,11 @@
1
+ [**@rxap/ngx-pub-sub**](../README.md)
2
+
3
+ ***
4
+
5
+ [@rxap/ngx-pub-sub](../globals.md) / RXAP\_PUB\_SUB\_CACHE\_SIZE
6
+
7
+ # Variable: RXAP\_PUB\_SUB\_CACHE\_SIZE
8
+
9
+ > `const` **RXAP\_PUB\_SUB\_CACHE\_SIZE**: `InjectionToken`\<`number`\>
10
+
11
+ Defined in: [tokens.ts:3](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/tokens.ts#L3)
@@ -0,0 +1,11 @@
1
+ [**@rxap/ngx-pub-sub**](../README.md)
2
+
3
+ ***
4
+
5
+ [@rxap/ngx-pub-sub](../globals.md) / RXAP\_PUB\_SUB\_DISABLE\_CACHE
6
+
7
+ # Variable: RXAP\_PUB\_SUB\_DISABLE\_CACHE
8
+
9
+ > `const` **RXAP\_PUB\_SUB\_DISABLE\_CACHE**: `InjectionToken`\<`boolean`\>
10
+
11
+ Defined in: [tokens.ts:14](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/tokens.ts#L14)
@@ -0,0 +1,11 @@
1
+ [**@rxap/ngx-pub-sub**](../README.md)
2
+
3
+ ***
4
+
5
+ [@rxap/ngx-pub-sub](../globals.md) / RXAP\_PUB\_SUB\_DISABLE\_GARBAGE\_COLLECTOR
6
+
7
+ # Variable: RXAP\_PUB\_SUB\_DISABLE\_GARBAGE\_COLLECTOR
8
+
9
+ > `const` **RXAP\_PUB\_SUB\_DISABLE\_GARBAGE\_COLLECTOR**: `InjectionToken`\<`boolean`\>
10
+
11
+ Defined in: [tokens.ts:19](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/tokens.ts#L19)
@@ -0,0 +1,11 @@
1
+ [**@rxap/ngx-pub-sub**](../README.md)
2
+
3
+ ***
4
+
5
+ [@rxap/ngx-pub-sub](../globals.md) / RXAP\_PUB\_SUB\_GARBAGE\_COLLECTOR\_INTERVAL
6
+
7
+ # Variable: RXAP\_PUB\_SUB\_GARBAGE\_COLLECTOR\_INTERVAL
8
+
9
+ > `const` **RXAP\_PUB\_SUB\_GARBAGE\_COLLECTOR\_INTERVAL**: `InjectionToken`\<`number`\>
10
+
11
+ Defined in: [tokens.ts:8](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/tokens.ts#L8)
@@ -0,0 +1,82 @@
1
+ [**@rxap/ngx-pub-sub**](../README.md)
2
+
3
+ ***
4
+
5
+ [@rxap/ngx-pub-sub](../globals.md) / RXAP\_TOPICS
6
+
7
+ # Variable: RXAP\_TOPICS
8
+
9
+ > `const` **RXAP\_TOPICS**: `object`
10
+
11
+ Defined in: [topics.ts:1](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/topics.ts#L1)
12
+
13
+ ## Type declaration
14
+
15
+ ### authentication
16
+
17
+ > **authentication**: `object`
18
+
19
+ #### authentication.login
20
+
21
+ > **login**: `string` = `'rxap:authentication:login'`
22
+
23
+ #### authentication.logout
24
+
25
+ > **logout**: `string` = `'authentication.logout'`
26
+
27
+ ### theme
28
+
29
+ > **theme**: `object`
30
+
31
+ #### theme.darkMode
32
+
33
+ > **darkMode**: `object`
34
+
35
+ #### theme.darkMode.changed
36
+
37
+ > **changed**: `string` = `'rxap:theme:darkMode:changed'`
38
+
39
+ #### theme.darkMode.restore
40
+
41
+ > **restore**: `string` = `'rxap:theme:darkMode:restore'`
42
+
43
+ #### theme.density
44
+
45
+ > **density**: `object`
46
+
47
+ restore is used by the UserSettingsThemeService after the theme is loaded and then used by the ThemeService to
48
+ set the restored theme properties
49
+
50
+ changed is used by the ThemeService to notify the UserSettingsThemeService that the theme properties have changed
51
+
52
+ #### theme.density.changed
53
+
54
+ > **changed**: `string` = `'rxap:theme:density:changed'`
55
+
56
+ #### theme.density.restore
57
+
58
+ > **restore**: `string` = `'rxap:theme:density:restore'`
59
+
60
+ #### theme.preset
61
+
62
+ > **preset**: `object`
63
+
64
+ #### theme.preset.changed
65
+
66
+ > **changed**: `string` = `'rxap:theme:preset:changed'`
67
+
68
+ #### theme.preset.restore
69
+
70
+ > **restore**: `string` = `'rxap:theme:preset:restore'`
71
+
72
+ #### theme.typography
73
+
74
+ > **typography**: `object`
75
+
76
+ #### theme.typography.changed
77
+
78
+ > **changed**: `string` = `'rxap:theme:typography:changed'`
79
+
80
+ #### theme.typography.restore
81
+
82
+ > **restore**: `string` = `'rxap:theme:typography:restore'`
@@ -0,0 +1,101 @@
1
+ [@rxap/ngx-pub-sub](../wiki/globals) / MessageMetaData
2
+
3
+ # Class: MessageMetaData\<T\>
4
+
5
+ Defined in: [message-meta-data.ts:1](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/message-meta-data.ts#L1)
6
+
7
+ ## Type Parameters
8
+
9
+ • **T** = `unknown`
10
+
11
+ ## Constructors
12
+
13
+ ### new MessageMetaData()
14
+
15
+ > **new MessageMetaData**\<`T`\>(`_topic`, `_data`?): [`MessageMetaData`](../wiki/Class.MessageMetaData)\<`T`\>
16
+
17
+ Defined in: [message-meta-data.ts:20](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/message-meta-data.ts#L20)
18
+
19
+ Constructor for this class.
20
+
21
+ #### Parameters
22
+
23
+ ##### \_topic
24
+
25
+ `string`
26
+
27
+ Original topic associated to the message sent through the events bus.
28
+
29
+ ##### \_data?
30
+
31
+ `T`
32
+
33
+ Optional: Additional data sent with the message.
34
+
35
+ #### Returns
36
+
37
+ [`MessageMetaData`](../wiki/Class.MessageMetaData)\<`T`\>
38
+
39
+ ## Accessors
40
+
41
+ ### data
42
+
43
+ #### Get Signature
44
+
45
+ > **get** **data**(): `undefined` \| `T`
46
+
47
+ Defined in: [message-meta-data.ts:53](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/message-meta-data.ts#L53)
48
+
49
+ Data associated to message. It's optional.
50
+
51
+ ##### Returns
52
+
53
+ `undefined` \| `T`
54
+
55
+ ***
56
+
57
+ ### id
58
+
59
+ #### Get Signature
60
+
61
+ > **get** **id**(): `string`
62
+
63
+ Defined in: [message-meta-data.ts:39](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/message-meta-data.ts#L39)
64
+
65
+ Gets unique identifier of the message sent through the events bus.
66
+
67
+ ##### Returns
68
+
69
+ `string`
70
+
71
+ ***
72
+
73
+ ### timestamp
74
+
75
+ #### Get Signature
76
+
77
+ > **get** **timestamp**(): `number`
78
+
79
+ Defined in: [message-meta-data.ts:60](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/message-meta-data.ts#L60)
80
+
81
+ Gets the time in milliseconds in which the message was generated.
82
+
83
+ ##### Returns
84
+
85
+ `number`
86
+
87
+ ***
88
+
89
+ ### topic
90
+
91
+ #### Get Signature
92
+
93
+ > **get** **topic**(): `string`
94
+
95
+ Defined in: [message-meta-data.ts:46](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/message-meta-data.ts#L46)
96
+
97
+ Original topic associated to the message.
98
+
99
+ ##### Returns
100
+
101
+ `string`
@@ -0,0 +1,238 @@
1
+ [@rxap/ngx-pub-sub](../wiki/globals) / PubSubService
2
+
3
+ # Class: PubSubService
4
+
5
+ Defined in: [pub-sub.service.ts:32](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/pub-sub.service.ts#L32)
6
+
7
+ ## Implements
8
+
9
+ - `OnDestroy`
10
+
11
+ ## Constructors
12
+
13
+ ### new PubSubService()
14
+
15
+ > **new PubSubService**(): [`PubSubService`](../wiki/Class.PubSubService)
16
+
17
+ #### Returns
18
+
19
+ [`PubSubService`](../wiki/Class.PubSubService)
20
+
21
+ ## Accessors
22
+
23
+ ### cacheSize
24
+
25
+ #### Get Signature
26
+
27
+ > **get** **cacheSize**(): `number`
28
+
29
+ Defined in: [pub-sub.service.ts:50](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/pub-sub.service.ts#L50)
30
+
31
+ ##### Returns
32
+
33
+ `number`
34
+
35
+ ## Methods
36
+
37
+ ### getFromCache()
38
+
39
+ > **getFromCache**\<`T`\>(`topic`, `limit`): [`MessageMetaData`](../wiki/Class.MessageMetaData)\<`T`\>[]
40
+
41
+ Defined in: [pub-sub.service.ts:199](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/pub-sub.service.ts#L199)
42
+
43
+ #### Type Parameters
44
+
45
+ • **T** = `unknown`
46
+
47
+ #### Parameters
48
+
49
+ ##### topic
50
+
51
+ `string`
52
+
53
+ Topic to identify the message.
54
+
55
+ ##### limit
56
+
57
+ `number` = `0`
58
+
59
+ Maximum number of messages to return.
60
+
61
+ #### Returns
62
+
63
+ [`MessageMetaData`](../wiki/Class.MessageMetaData)\<`T`\>[]
64
+
65
+ ***
66
+
67
+ ### ngOnDestroy()
68
+
69
+ > **ngOnDestroy**(): `void`
70
+
71
+ Defined in: [pub-sub.service.ts:93](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/pub-sub.service.ts#L93)
72
+
73
+ A callback method that performs custom clean-up, invoked immediately
74
+ before a directive, pipe, or service instance is destroyed.
75
+
76
+ #### Returns
77
+
78
+ `void`
79
+
80
+ #### Implementation of
81
+
82
+ `OnDestroy.ngOnDestroy`
83
+
84
+ ***
85
+
86
+ ### publish()
87
+
88
+ > **publish**\<`T`\>(`topic`, `data`?, `retention`?): `void`
89
+
90
+ Defined in: [pub-sub.service.ts:143](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/pub-sub.service.ts#L143)
91
+
92
+ #### Type Parameters
93
+
94
+ • **T** = `unknown`
95
+
96
+ #### Parameters
97
+
98
+ ##### topic
99
+
100
+ `string`
101
+
102
+ Topic to identify the message.
103
+
104
+ ##### data?
105
+
106
+ `T`
107
+
108
+ Optional: Additional data sent with the message.
109
+
110
+ ##### retention?
111
+
112
+ `number`
113
+
114
+ Optional: Retention time in milliseconds.
115
+
116
+ #### Returns
117
+
118
+ `void`
119
+
120
+ #### Throws
121
+
122
+ topic parameter must be a string and must not be empty.
123
+
124
+ ***
125
+
126
+ ### runGarbageCollector()
127
+
128
+ > **runGarbageCollector**(): `void`
129
+
130
+ Defined in: [pub-sub.service.ts:77](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/pub-sub.service.ts#L77)
131
+
132
+ #### Returns
133
+
134
+ `void`
135
+
136
+ ***
137
+
138
+ ### setMaxCacheSize()
139
+
140
+ > **setMaxCacheSize**(`size`): `void`
141
+
142
+ Defined in: [pub-sub.service.ts:54](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/pub-sub.service.ts#L54)
143
+
144
+ #### Parameters
145
+
146
+ ##### size
147
+
148
+ `number`
149
+
150
+ #### Returns
151
+
152
+ `void`
153
+
154
+ ***
155
+
156
+ ### startGarbageCollector()
157
+
158
+ > **startGarbageCollector**(): `void`
159
+
160
+ Defined in: [pub-sub.service.ts:58](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/pub-sub.service.ts#L58)
161
+
162
+ #### Returns
163
+
164
+ `void`
165
+
166
+ ***
167
+
168
+ ### stopGarbageCollector()
169
+
170
+ > **stopGarbageCollector**(): `void`
171
+
172
+ Defined in: [pub-sub.service.ts:89](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/pub-sub.service.ts#L89)
173
+
174
+ #### Returns
175
+
176
+ `void`
177
+
178
+ ***
179
+
180
+ ### subscribe()
181
+
182
+ > **subscribe**\<`T`\>(`topic`, `replayCount`?): `Observable`\<[`MessageMetaData`](../wiki/Class.MessageMetaData)\<`T`\>\>
183
+
184
+ Defined in: [pub-sub.service.ts:173](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/pub-sub.service.ts#L173)
185
+
186
+ #### Type Parameters
187
+
188
+ • **T** = `unknown`
189
+
190
+ #### Parameters
191
+
192
+ ##### topic
193
+
194
+ `string`
195
+
196
+ Topic to identify the message.
197
+
198
+ ##### replayCount?
199
+
200
+ `number`
201
+
202
+ Number of messages to replay.
203
+
204
+ #### Returns
205
+
206
+ `Observable`\<[`MessageMetaData`](../wiki/Class.MessageMetaData)\<`T`\>\>
207
+
208
+ Observable you can subscribe to listen messages.
209
+
210
+ ***
211
+
212
+ ### topicMatch()
213
+
214
+ > **topicMatch**(`topic`, `wildcard`): `boolean`
215
+
216
+ Defined in: [pub-sub.service.ts:105](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/pub-sub.service.ts#L105)
217
+
218
+ Validates topic matching.
219
+
220
+ #### Parameters
221
+
222
+ ##### topic
223
+
224
+ `string`
225
+
226
+ Topic to identify the message/event.
227
+
228
+ ##### wildcard
229
+
230
+ `string`
231
+
232
+ Wildcard received from on method.
233
+
234
+ #### Returns
235
+
236
+ `boolean`
237
+
238
+ true if topic matches, false otherwise.
@@ -0,0 +1,17 @@
1
+ [@rxap/ngx-pub-sub](../wiki/globals) / ProvidePubSub
2
+
3
+ # Function: ProvidePubSub()
4
+
5
+ > **ProvidePubSub**(...`providers`): (`Provider` \| `EnvironmentProviders`)[]
6
+
7
+ Defined in: [provide.ts:13](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/provide.ts#L13)
8
+
9
+ ## Parameters
10
+
11
+ ### providers
12
+
13
+ ...`Provider`[]
14
+
15
+ ## Returns
16
+
17
+ (`Provider` \| `EnvironmentProviders`)[]
@@ -0,0 +1,11 @@
1
+ [@rxap/ngx-pub-sub](../wiki/globals) / withDisableCache
2
+
3
+ # Function: withDisableCache()
4
+
5
+ > **withDisableCache**(): `Provider`
6
+
7
+ Defined in: [provide.ts:23](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/provide.ts#L23)
8
+
9
+ ## Returns
10
+
11
+ `Provider`
@@ -0,0 +1,11 @@
1
+ [@rxap/ngx-pub-sub](../wiki/globals) / withDisableGarbageCollector
2
+
3
+ # Function: withDisableGarbageCollector()
4
+
5
+ > **withDisableGarbageCollector**(): `Provider`
6
+
7
+ Defined in: [provide.ts:30](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/provide.ts#L30)
8
+
9
+ ## Returns
10
+
11
+ `Provider`
@@ -0,0 +1,17 @@
1
+ [@rxap/ngx-pub-sub](../wiki/globals) / withGarbageCollectorInterval
2
+
3
+ # Function: withGarbageCollectorInterval()
4
+
5
+ > **withGarbageCollectorInterval**(`interval`): `Provider`
6
+
7
+ Defined in: [provide.ts:44](https://gitlab.com/rxap/packages/-/blob/753c877fe1a5c2fcfa737310f6e99fd1371f9b4d/packages/angular/pub-sub/src/lib/provide.ts#L44)
8
+
9
+ ## Parameters
10
+
11
+ ### interval
12
+
13
+ `number`
14
+
15
+ ## Returns
16
+
17
+ `Provider`