Class ParserMsClient

Client to access the main indexer service through the broker.

Hierarchy

MsClientWithEvents<Event>
- ParserMsClient

Index

Constructors

constructor

new ParserMsClient(broker: ServiceBroker, blockchains: Record<Blockchain, ParserClientI<any, any>>, clientEvents?: boolean, eventOpts?: EventOptions, msId?: MsIds): ParserMsClient
Parameters
- broker: ServiceBroker
  
  The broker instance to retrieve the actual service from.
- blockchains: Record<Blockchain, ParserClientI<any, any>>
- clientEvents: boolean = false
  
  If true, the client will listen to the events of the service.
- Optional eventOpts: EventOptions
  
  The event options
- msId: MsIds = MsIds.Parser
  
  The moleculer service id of the indexer service.
Returns ParserMsClient
Overrides MsClientWithEvents<Event>.constructor
- Defined in packages/framework/src/services/parser/client.ts:24

Properties

`Protected` _self

_self: typeof MsClientWithEvents = ...

`Protected` blockchains

blockchains: Record<Blockchain, ParserClientI<any, any>>

`Protected` broker

broker: ServiceBroker

The broker instance to retrieve the actual service from.

`Protected` clientEvents

clientEvents: boolean = false

If true, the client will listen to the events of the service.

`Protected` `Optional` eventOpts

eventOpts?: EventOptions

The event options

`Protected` id

id: MsIds

The service type of the client.

`Protected` initService

initService: boolean = true

Whether to initialize the service on the broker.

`Protected` msId

msId: MsIds = MsIds.Parser

The moleculer service id of the indexer service.

Methods

getAllBlockchains

getAllBlockchains(): Blockchain[]
Returns Blockchain[]
- Defined in packages/framework/src/services/parser/client.ts:45

getAllFetchers

getAllFetchers(): string[]
Returns string[]
- Defined in packages/framework/src/services/parser/client.ts:41

`Protected` getBlockchainClientInstance

getBlockchainClientInstance<RE, PE>(blockchainId: Blockchain): ParserClientI<RE, PE>
Type Parameters
- RE extends RawEntity = RawEntity
- PE extends ParsedEntity<unknown> = ParsedEntity<unknown>
Parameters
- blockchainId: Blockchain
Returns ParserClientI<RE, PE>
- Defined in packages/framework/src/services/parser/client.ts:61

getNodeId

getNodeId(): string
Returns string
- Defined in packages/framework/src/services/parser/client.ts:49

off

off(eventId: string, handler: ((payload: any) => any)): ParserMsClient
Parameters
- eventId: string
- handler: ((payload: any) => any)
  - - (payload: any): any
    - Parameters
      
      payload: any
      
      Returns any
Returns ParserMsClient
Inherited from MsClientWithEvents.off
- Defined in packages/framework/src/services/common.ts:150

on

on(eventId: string, handler: ((payload: any) => any)): ParserMsClient
Adds a hook to the given event.
Parameters
- eventId: string
  
  Event type to listen for.
- handler: ((payload: any) => any)
  
  Function to call when event is emitted.
  - - (payload: any): any
    - Parameters
      
      payload: any
      
      Returns any
Returns ParserMsClient
Inherited from MsClientWithEvents.on
- Defined in packages/framework/src/services/common.ts:139

useBlockchain

useBlockchain<RE, PE>(blockchainId: Blockchain): ParserClientI<RE, PE>
Type Parameters
- RE extends RawEntity = RawEntity
- PE extends ParsedEntity<unknown> = ParsedEntity<unknown>
Parameters
- blockchainId: Blockchain
Returns ParserClientI<RE, PE>
- Defined in packages/framework/src/services/parser/client.ts:34

waitForAll

waitForAll(indexers: string[]): Promise<void>
Parameters
- indexers: string[]
Returns Promise<void>
- Defined in packages/framework/src/services/parser/client.ts:53

waitForService

waitForService(): Promise<void>
Returns Promise<void>
- Defined in packages/framework/src/services/parser/client.ts:57

Class ParserMsClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

broker: ServiceBroker

blockchains: Record<Blockchain, ParserClientI<any, any>>

clientEvents: boolean = false

Optional eventOpts: EventOptions

msId: MsIds = MsIds.Parser

Returns ParserMsClient

Properties

Protected _self

Protected blockchains

Protected broker

Protected clientEvents

Protected Optional eventOpts

Protected id

Protected initService

Protected msId

Methods

getAllBlockchains

Returns Blockchain[]

getAllFetchers

Returns string[]

Protected getBlockchainClientInstance

Type Parameters

RE extends RawEntity = RawEntity

PE extends ParsedEntity<unknown> = ParsedEntity<unknown>

Parameters

blockchainId: Blockchain

Returns ParserClientI<RE, PE>

getNodeId

Returns string

off

Parameters

eventId: string

handler: ((payload: any) => any)

Parameters

payload: any

Returns any

Returns ParserMsClient

on

Parameters

eventId: string

handler: ((payload: any) => any)

Parameters

payload: any

Returns any

Returns ParserMsClient

useBlockchain

Type Parameters

RE extends RawEntity = RawEntity

PE extends ParsedEntity<unknown> = ParsedEntity<unknown>

Parameters

blockchainId: Blockchain

Returns ParserClientI<RE, PE>

waitForAll

Parameters

indexers: string[]

Returns Promise<void>

waitForService

Returns Promise<void>

Settings

Member Visibility

Theme

`Optional` eventOpts: EventOptions

`Protected` _self

`Protected` blockchains

`Protected` broker

`Protected` clientEvents

`Protected` `Optional` eventOpts

`Protected` id

`Protected` initService

`Protected` msId

`Protected` getBlockchainClientInstance