Class BaseFetcherClient`Abstract`

Client to access the main fetcher service through the broker.

Hierarchy

BaseFetcherClient

Implements

FetcherClientI

Index

Constructors

constructor

new BaseFetcherClient(blockchainId: Blockchain, broker: ServiceBroker, msId?: MsIds): BaseFetcherClient
Parameters
- blockchainId: Blockchain
  
  The id of the blockchain the client handles
- broker: ServiceBroker
  
  The broker instance to retrieve the actual service from.
- msId: MsIds = MsIds.Fetcher
  
  The moleculer service id of the fetcher service.
Returns BaseFetcherClient
- Defined in packages/framework/src/services/fetcher/src/client.ts:32

Properties

`Protected` blockchainId

blockchainId: Blockchain

The id of the blockchain the client handles

`Protected` broker

broker: ServiceBroker

The broker instance to retrieve the actual service from.

`Protected` msId

msId: MsIds = MsIds.Fetcher

The moleculer service id of the fetcher service.

Methods

addAccountEntityFetcher

addAccountEntityFetcher(args: Omit<AddAccountEntityRequestArgs, "blockchainId">): Promise<void>
Parameters
- args: Omit<AddAccountEntityRequestArgs, "blockchainId">
Returns Promise<void>
Implementation of FetcherClientI.addAccountEntityFetcher
- Defined in packages/framework/src/services/fetcher/src/client.ts:42

delAccountEntityFetcher

delAccountEntityFetcher(args: Omit<DelAccountEntityRequestArgs, "blockchainId">): Promise<void>
Parameters
- args: Omit<DelAccountEntityRequestArgs, "blockchainId">
Returns Promise<void>
Implementation of FetcherClientI.delAccountEntityFetcher
- Defined in packages/framework/src/services/fetcher/src/client.ts:56

delEntityCache

delEntityCache(args: DelEntityRequestArgs): Promise<void>
Parameters
- args: DelEntityRequestArgs
Returns Promise<void>
Implementation of FetcherClientI.delEntityCache
- Defined in packages/framework/src/services/fetcher/src/client.ts:144

fetchAccountEntitiesByDate

fetchAccountEntitiesByDate(args: Omit<FetchAccountEntitiesByDateRequestArgs, "blockchainId">): Promise<void | AsyncIterable<string[]>>
Parameters
- args: Omit<FetchAccountEntitiesByDateRequestArgs, "blockchainId">
Returns Promise<void | AsyncIterable<string[]>>
Implementation of FetcherClientI.fetchAccountEntitiesByDate
- Defined in packages/framework/src/services/fetcher/src/client.ts:84

fetchEntitiesById

fetchEntitiesById(args: Omit<FetchEntitiesByIdRequestArgs, "blockchainId">): Promise<void>
Parameters
- args: Omit<FetchEntitiesByIdRequestArgs, "blockchainId">
Returns Promise<void>
Implementation of FetcherClientI.fetchEntitiesById
- Defined in packages/framework/src/services/fetcher/src/client.ts:101

getAccountEntityFetcherState

getAccountEntityFetcherState(args: Omit<GetAccountEntityStateRequestArgs, "blockchainId">): Promise<undefined | AccountEntityHistoryState<unknown>>
Parameters
- args: Omit<GetAccountEntityStateRequestArgs, "blockchainId">
Returns Promise<undefined | AccountEntityHistoryState<unknown>>
Implementation of FetcherClientI.getAccountEntityFetcherState
- Defined in packages/framework/src/services/fetcher/src/client.ts:70

`Protected` getEntityPartitionGroups

getEntityPartitionGroups(args: {
ids: string[];
partitionKey?: string;
}): Record<string, string[]>
Parameters
- args: {
  ids: string[];
  partitionKey?: string;
  }
  - ids: string[]
  - Optional partitionKey?: string
Returns Record<string, string[]>
- Defined in packages/framework/src/services/fetcher/src/client.ts:170

getEntityState

getEntityState(args: CheckEntityRequestArgs): Promise<EntityState[]>
Parameters
- args: CheckEntityRequestArgs
Returns Promise<EntityState[]>
Implementation of FetcherClientI.getEntityState
- Defined in packages/framework/src/services/fetcher/src/client.ts:128

getFetcherState

getFetcherState(args: Omit<FetcherStateRequestArgs, "blockchainId">): Promise<FetcherState<any>>
Parameters
- args: Omit<FetcherStateRequestArgs, "blockchainId">
Returns Promise<FetcherState<any>>
- Defined in packages/framework/src/services/fetcher/src/client.ts:120

`Protected` invokeBlockchainMethod

invokeBlockchainMethod<R, A>(args: Omit<InvokeBlockchainMethodRequestArgs<A>, "blockchainId">): Promise<R>
Type Parameters
- R
- A
Parameters
- args: Omit<InvokeBlockchainMethodRequestArgs<A>, "blockchainId">
Returns Promise<R>
- Defined in packages/framework/src/services/fetcher/src/client.ts:158

`Protected` mapEntityIds

mapEntityIds(args: {
ids: string[];
type: IndexableEntityType;
}): string[]
Parameters
- args: {
  ids: string[];
  type: IndexableEntityType;
  }
  - ids: string[]
  - type: IndexableEntityType
Returns string[]
- Defined in packages/framework/src/services/fetcher/src/client.ts:186

`Abstract` normalizeAccount

normalizeAccount(account: string): string
Parameters
- account: string
Returns string
Implementation of FetcherClientI.normalizeAccount
- Defined in packages/framework/src/services/fetcher/src/client.ts:38

`Abstract` normalizeEntityId

normalizeEntityId(entity: IndexableEntityType, id: string): string
Parameters
- entity: IndexableEntityType
- id: string
Returns string
Implementation of FetcherClientI.normalizeEntityId
- Defined in packages/framework/src/services/fetcher/src/client.ts:40

Class BaseFetcherClientAbstract

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

blockchainId: Blockchain

broker: ServiceBroker

msId: MsIds = MsIds.Fetcher

Returns BaseFetcherClient

Properties

Protected blockchainId

Protected broker

Protected msId

Methods

addAccountEntityFetcher

Parameters

args: Omit<AddAccountEntityRequestArgs, "blockchainId">

Returns Promise<void>

delAccountEntityFetcher

Parameters

args: Omit<DelAccountEntityRequestArgs, "blockchainId">

Returns Promise<void>

delEntityCache

Parameters

args: DelEntityRequestArgs

Returns Promise<void>

fetchAccountEntitiesByDate

Parameters

args: Omit<FetchAccountEntitiesByDateRequestArgs, "blockchainId">

Returns Promise<void | AsyncIterable<string[]>>

fetchEntitiesById

Parameters

args: Omit<FetchEntitiesByIdRequestArgs, "blockchainId">

Returns Promise<void>

getAccountEntityFetcherState

Parameters

args: Omit<GetAccountEntityStateRequestArgs, "blockchainId">

Returns Promise<undefined | AccountEntityHistoryState<unknown>>

Protected getEntityPartitionGroups

Parameters

args: { ids: string[]; partitionKey?: string; }

ids: string[]

Optional partitionKey?: string

Returns Record<string, string[]>

getEntityState

Parameters

args: CheckEntityRequestArgs

Returns Promise<EntityState[]>

getFetcherState

Parameters

args: Omit<FetcherStateRequestArgs, "blockchainId">

Returns Promise<FetcherState<any>>

Protected invokeBlockchainMethod

Type Parameters

R

A

Parameters

args: Omit<InvokeBlockchainMethodRequestArgs<A>, "blockchainId">

Returns Promise<R>

Protected mapEntityIds

Parameters

args: { ids: string[]; type: IndexableEntityType; }

ids: string[]

type: IndexableEntityType

Returns string[]

Abstract normalizeAccount

Parameters

account: string

Returns string

Abstract normalizeEntityId

Parameters

entity: IndexableEntityType

id: string

Returns string

Settings

Class BaseFetcherClient`Abstract`

`Protected` blockchainId

`Protected` broker

`Protected` msId

`Protected` getEntityPartitionGroups

args: {
ids: string[];
partitionKey?: string;
}

`Optional` partitionKey?: string

`Protected` invokeBlockchainMethod

`Protected` mapEntityIds

args: {
ids: string[];
type: IndexableEntityType;
}

`Abstract` normalizeAccount

`Abstract` normalizeEntityId