Changes

Page history
Update generated documentation authored by Mateusz Tyszczak's avatar Mateusz Tyszczak
Hide whitespace changes
Inline Side-by-side
classes/ImpactedAccountProvider.md
View page @ 1de068ee
......@@ -4,7 +4,7 @@
## Extends
- `ProviderBase`\<`IImpactedAccountProviderOptions`\>
- `ProviderBase`\<`IImpactedAccountProviderOptions`, [`IImpactedAccountProviderData`](../interfaces/IImpactedAccountProviderData)\<`TAccounts`\>\>
## Type Parameters
......@@ -22,7 +22,7 @@
#### Inherited from
`ProviderBase<IImpactedAccountProviderOptions>.constructor`
`ProviderBase<IImpactedAccountProviderOptions, IImpactedAccountProviderData<TAccounts>>.constructor`
## Properties
......@@ -32,7 +32,34 @@
#### Defined in
[src/chain-observers/providers/impacted-account-provider.ts:22](https://gitlab.syncad.com/hive/workerbee/-/blob/e4d5e483e38bcb779739e95ee020551205c37f5b/src/chain-observers/providers/impacted-account-provider.ts#L22)
[src/chain-observers/providers/impacted-account-provider.ts:24](https://gitlab.syncad.com/hive/workerbee/-/blob/ae5a5f204b6abece4b4e999e0a6131ef043a978d/src/chain-observers/providers/impacted-account-provider.ts#L24)
## 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/ae5a5f204b6abece4b4e999e0a6131ef043a978d/src/chain-observers/providers/impacted-account-provider.ts#L37)
## Methods
......@@ -56,7 +83,7 @@
#### Defined in
[src/chain-observers/providers/impacted-account-provider.ts:35](https://gitlab.syncad.com/hive/workerbee/-/blob/e4d5e483e38bcb779739e95ee020551205c37f5b/src/chain-observers/providers/impacted-account-provider.ts#L35)
[src/chain-observers/providers/impacted-account-provider.ts:43](https://gitlab.syncad.com/hive/workerbee/-/blob/ae5a5f204b6abece4b4e999e0a6131ef043a978d/src/chain-observers/providers/impacted-account-provider.ts#L43)
***
......@@ -80,7 +107,7 @@
#### Defined in
[src/chain-observers/providers/impacted-account-provider.ts:24](https://gitlab.syncad.com/hive/workerbee/-/blob/e4d5e483e38bcb779739e95ee020551205c37f5b/src/chain-observers/providers/impacted-account-provider.ts#L24)
[src/chain-observers/providers/impacted-account-provider.ts:26](https://gitlab.syncad.com/hive/workerbee/-/blob/ae5a5f204b6abece4b4e999e0a6131ef043a978d/src/chain-observers/providers/impacted-account-provider.ts#L26)
***
......@@ -98,4 +125,4 @@
#### Defined in
[src/chain-observers/providers/impacted-account-provider.ts:29](https://gitlab.syncad.com/hive/workerbee/-/blob/e4d5e483e38bcb779739e95ee020551205c37f5b/src/chain-observers/providers/impacted-account-provider.ts#L29)
[src/chain-observers/providers/impacted-account-provider.ts:31](https://gitlab.syncad.com/hive/workerbee/-/blob/ae5a5f204b6abece4b4e999e0a6131ef043a978d/src/chain-observers/providers/impacted-account-provider.ts#L31)