Changes

Page history
Update generated documentation authored by Fabian Waszkiewicz's avatar Fabian Waszkiewicz
Show whitespace changes
Inline Side-by-side
classes/ImpactedAccountProvider.md
View page @ ab2073fb
...@@ -4,7 +4,7 @@ ...@@ -4,7 +4,7 @@
## Extends ## Extends
- `ProviderBase`\<`IImpactedAccountProviderOptions`, [`IImpactedAccountProviderData`](../interfaces/IImpactedAccountProviderData)\<`TAccounts`\>\> - `ProviderBase`\<`IImpactedAccountProviderOptions`\>
## Type Parameters ## Type Parameters
...@@ -22,7 +22,7 @@ ...@@ -22,7 +22,7 @@
#### Inherited from #### Inherited from
`ProviderBase<IImpactedAccountProviderOptions, IImpactedAccountProviderData<TAccounts>>.constructor` `ProviderBase<IImpactedAccountProviderOptions>.constructor`
## Properties ## Properties
...@@ -32,34 +32,7 @@ ...@@ -32,34 +32,7 @@
#### Defined in #### Defined in
[src/chain-observers/providers/impacted-account-provider.ts:24](https://gitlab.syncad.com/hive/workerbee/-/blob/30f72e0dde6d1f1072134e9d382b393e274a96a8/src/chain-observers/providers/impacted-account-provider.ts#L24) [src/chain-observers/providers/impacted-account-provider.ts:22](https://gitlab.syncad.com/hive/workerbee/-/blob/0dba6ec9fe2910dd9d88d0d4d3b2b263fe822ba7/src/chain-observers/providers/impacted-account-provider.ts#L22)
## Accessors
### baseStructure
#### Get Signature
> **get** **baseStructure**(): [`IImpactedAccountProviderData`](../interfaces/IImpactedAccountProviderData)\<`TAccounts`\>
The base structure of the data provided by this provider.
This can be used for type checking and ensuring that the data provided by the provider adheres to a specific structure.
This is also called as a fallback when no data is provided by the provider, e.g. due to an error.
Note: This is intentionally a getter to avoid issues with shared state between multiple #provide calls
##### Returns
[`IImpactedAccountProviderData`](../interfaces/IImpactedAccountProviderData)\<`TAccounts`\>
#### Overrides
`ProviderBase.baseStructure`
#### Defined in
[src/chain-observers/providers/impacted-account-provider.ts:37](https://gitlab.syncad.com/hive/workerbee/-/blob/30f72e0dde6d1f1072134e9d382b393e274a96a8/src/chain-observers/providers/impacted-account-provider.ts#L37)
## Methods ## Methods
...@@ -83,7 +56,7 @@ Note: This is intentionally a getter to avoid issues with shared state between m ...@@ -83,7 +56,7 @@ Note: This is intentionally a getter to avoid issues with shared state between m
#### Defined in #### Defined in
[src/chain-observers/providers/impacted-account-provider.ts:43](https://gitlab.syncad.com/hive/workerbee/-/blob/30f72e0dde6d1f1072134e9d382b393e274a96a8/src/chain-observers/providers/impacted-account-provider.ts#L43) [src/chain-observers/providers/impacted-account-provider.ts:35](https://gitlab.syncad.com/hive/workerbee/-/blob/0dba6ec9fe2910dd9d88d0d4d3b2b263fe822ba7/src/chain-observers/providers/impacted-account-provider.ts#L35)
*** ***
...@@ -107,7 +80,7 @@ Note: This is intentionally a getter to avoid issues with shared state between m ...@@ -107,7 +80,7 @@ Note: This is intentionally a getter to avoid issues with shared state between m
#### Defined in #### Defined in
[src/chain-observers/providers/impacted-account-provider.ts:26](https://gitlab.syncad.com/hive/workerbee/-/blob/30f72e0dde6d1f1072134e9d382b393e274a96a8/src/chain-observers/providers/impacted-account-provider.ts#L26) [src/chain-observers/providers/impacted-account-provider.ts:24](https://gitlab.syncad.com/hive/workerbee/-/blob/0dba6ec9fe2910dd9d88d0d4d3b2b263fe822ba7/src/chain-observers/providers/impacted-account-provider.ts#L24)
*** ***
...@@ -125,4 +98,4 @@ Note: This is intentionally a getter to avoid issues with shared state between m ...@@ -125,4 +98,4 @@ Note: This is intentionally a getter to avoid issues with shared state between m
#### Defined in #### Defined in
[src/chain-observers/providers/impacted-account-provider.ts:31](https://gitlab.syncad.com/hive/workerbee/-/blob/30f72e0dde6d1f1072134e9d382b393e274a96a8/src/chain-observers/providers/impacted-account-provider.ts#L31) [src/chain-observers/providers/impacted-account-provider.ts:29](https://gitlab.syncad.com/hive/workerbee/-/blob/0dba6ec9fe2910dd9d88d0d4d3b2b263fe822ba7/src/chain-observers/providers/impacted-account-provider.ts#L29)