Class IndexerMs

A wrapper of the Molueculer service to expose the main indexer service through the broker.

Hierarchy

Service
- IndexerMs

Constructors

constructor

new IndexerMs(broker: ServiceBroker): IndexerMs
Parameters
- broker: ServiceBroker
Returns IndexerMs
Overrides Service.constructor
- Defined in packages/framework/src/services/indexer/ms.ts:21

Properties

Promise

Promise: PromiseConstructorLike

actions

actions: ServiceActions

broker

broker: ServiceBroker

dependencies

dependencies: string | ServiceDependency | (string | ServiceDependency)[]

fullName

fullName: string

logger

logger: LoggerInstance

`Protected` main

main: IndexerMsMain

metadata

metadata: GenericObject

name

name: string

originalSchema

originalSchema: ServiceSchema<ServiceSettingSchema>

schema

schema: ServiceSchema<ServiceSettingSchema>

settings

settings: ServiceSettingSchema

`Optional` version

version?: string | number

`Static` mainFactory

mainFactory: MainFactory<IndexerMsMain>

Methods

_init

_init(): void
Returns void
Inherited from Service._init
- Defined in node_modules/moleculer/index.d.ts:776

_start

_start(): Promise<void>
Returns Promise<void>
Inherited from Service._start
- Defined in node_modules/moleculer/index.d.ts:777

_stop

_stop(): Promise<void>
Returns Promise<void>
Inherited from Service._stop
- Defined in node_modules/moleculer/index.d.ts:778

applyMixins

applyMixins(schema: ServiceSchema<ServiceSettingSchema>): ServiceSchema<ServiceSettingSchema>
Apply mixins list in schema. Merge the schema with mixins schemas. Returns with the mixed schema
Parameters
- schema: ServiceSchema<ServiceSettingSchema>
  
  Schema containing the mixins to merge
Returns ServiceSchema<ServiceSettingSchema>
Inherited from Service.applyMixins
- Defined in node_modules/moleculer/index.d.ts:810

deleteAccount

deleteAccount(ctx: Context<AccountIndexerRequestArgs, {}, GenericObject>): Promise<void>
Parameters
- ctx: Context<AccountIndexerRequestArgs, {}, GenericObject>
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/ms.ts:67

emitLocalEventHandler

emitLocalEventHandler(eventName: string, params?: any, opts?: any): any
Call a local event handler. Useful for unit tests.
Parameters
- eventName: string
  
  The event name
- Optional params: any
  
  The event parameters
- Optional opts: any
  
  The event options
Returns any
Inherited from Service.emitLocalEventHandler
- Defined in node_modules/moleculer/index.d.ts:787

getAccountState

getAccountState(ctx: Context<GetAccountIndexingEntityStateRequestArgs, {}, GenericObject>): Promise<undefined | AccountIndexerState>
Parameters
- ctx: Context<GetAccountIndexingEntityStateRequestArgs, {}, GenericObject>
Returns Promise<undefined | AccountIndexerState>
- Defined in packages/framework/src/services/indexer/ms.ts:71

getEntityPendingRequests

getEntityPendingRequests(ctx: Context<GetEntityPendingRequestsRequestArgs, {}, GenericObject>): Promise<EntityRequest[]>
Parameters
- ctx: Context<GetEntityPendingRequestsRequestArgs, {}, GenericObject>
Returns Promise<EntityRequest[]>
- Defined in packages/framework/src/services/indexer/ms.ts:81

indexAccount

indexAccount(ctx: Context<AccountIndexerRequestArgs, {}, GenericObject>): Promise<void>
Parameters
- ctx: Context<AccountIndexerRequestArgs, {}, GenericObject>
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/ms.ts:63

invokeDomainMethod

invokeDomainMethod(ctx: Context<InvokeMethodRequestArgs, {}, GenericObject>): Promise<unknown>
Parameters
- ctx: Context<InvokeMethodRequestArgs, {}, GenericObject>
Returns Promise<unknown>
- Defined in packages/framework/src/services/indexer/ms.ts:77

mergeSchemaActions

mergeSchemaActions(src: GenericObject, target: GenericObject): GenericObject
Merge actions property in schema
Parameters
- src: GenericObject
  
  Source schema property
- target: GenericObject
  
  Target schema property
Returns GenericObject
Inherited from Service.mergeSchemaActions
- Defined in node_modules/moleculer/index.d.ts:869

mergeSchemaDependencies

mergeSchemaDependencies(src: GenericObject, target: GenericObject): GenericObject
Merge dependencies property in schema
Parameters
- src: GenericObject
  
  Source schema property
- target: GenericObject
  
  Target schema property
Returns GenericObject
Inherited from Service.mergeSchemaDependencies
- Defined in node_modules/moleculer/index.d.ts:853

mergeSchemaEvents

mergeSchemaEvents(src: GenericObject, target: GenericObject): GenericObject
Merge events property in schema
Parameters
- src: GenericObject
  
  Source schema property
- target: GenericObject
  
  Target schema property
Returns GenericObject
Inherited from Service.mergeSchemaEvents
- Defined in node_modules/moleculer/index.d.ts:885

mergeSchemaHooks

mergeSchemaHooks(src: GenericObject, target: GenericObject): GenericObject
Merge hooks property in schema
Parameters
- src: GenericObject
  
  Source schema property
- target: GenericObject
  
  Target schema property
Returns GenericObject
Inherited from Service.mergeSchemaHooks
- Defined in node_modules/moleculer/index.d.ts:861

mergeSchemaLifecycleHandlers

mergeSchemaLifecycleHandlers(src: GenericObject, target: GenericObject): GenericObject
Merge started, stopped, created event handler properties in schema
Parameters
- src: GenericObject
  
  Source schema property
- target: GenericObject
  
  Target schema property
Returns GenericObject
Inherited from Service.mergeSchemaLifecycleHandlers
- Defined in node_modules/moleculer/index.d.ts:893

mergeSchemaMetadata

mergeSchemaMetadata(src: GenericObject, target: GenericObject): GenericObject
Merge metadata property in schema
Parameters
- src: GenericObject
  
  Source schema property
- target: GenericObject
  
  Target schema property
Returns GenericObject
Inherited from Service.mergeSchemaMetadata
- Defined in node_modules/moleculer/index.d.ts:837

mergeSchemaMethods

mergeSchemaMethods(src: GenericObject, target: GenericObject): GenericObject
Merge methods property in schema
Parameters
- src: GenericObject
  
  Source schema property
- target: GenericObject
  
  Target schema property
Returns GenericObject
Inherited from Service.mergeSchemaMethods
- Defined in node_modules/moleculer/index.d.ts:877

mergeSchemaSettings

mergeSchemaSettings(src: GenericObject, target: GenericObject): GenericObject
Merge settings property in schema
Parameters
- src: GenericObject
  
  Source schema property
- target: GenericObject
  
  Target schema property
Returns GenericObject
Inherited from Service.mergeSchemaSettings
- Defined in node_modules/moleculer/index.d.ts:829

mergeSchemaUniqArray

mergeSchemaUniqArray(src: GenericObject, target: GenericObject): GenericObject
Merge mixins property in schema
Parameters
- src: GenericObject
  
  Source schema property
- target: GenericObject
  
  Target schema property
Returns GenericObject
Inherited from Service.mergeSchemaUniqArray
- Defined in node_modules/moleculer/index.d.ts:845

mergeSchemaUnknown

mergeSchemaUnknown(src: GenericObject, target: GenericObject): GenericObject
Merge unknown properties in schema
Parameters
- src: GenericObject
  
  Source schema property
- target: GenericObject
  
  Target schema property
Returns GenericObject
Inherited from Service.mergeSchemaUnknown
- Defined in node_modules/moleculer/index.d.ts:901

mergeSchemas

mergeSchemas(mixinSchema: Partial<ServiceSchema<ServiceSettingSchema>>, svcSchema: Partial<ServiceSchema<ServiceSettingSchema>>): Partial<ServiceSchema<ServiceSettingSchema>>
Merge two Service schema
Parameters
- mixinSchema: Partial<ServiceSchema<ServiceSettingSchema>>
  
  Mixin schema
- svcSchema: Partial<ServiceSchema<ServiceSettingSchema>>
  
  Service schema
Returns Partial<ServiceSchema<ServiceSettingSchema>>
Inherited from Service.mergeSchemas
- Defined in node_modules/moleculer/index.d.ts:818

`Protected` parseServiceSchema

parseServiceSchema(schema: ServiceSchema<ServiceSettingSchema>): void
Parameters
- schema: ServiceSchema<ServiceSettingSchema>
Returns void
Inherited from Service.parseServiceSchema
- Defined in node_modules/moleculer/index.d.ts:761

start

start(): Promise<void>
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/ms.ts:55

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in packages/framework/src/services/indexer/ms.ts:59

waitForServices

waitForServices(serviceNames: string | string[] | ServiceDependency[], timeout?: number, interval?: number): Promise<WaitForServicesResult>
Wait for the specified services to become available/registered with this broker.
Parameters
- serviceNames: string | string[] | ServiceDependency[]
  
  The service, or services, we are waiting for.
- Optional timeout: number
  
  The total time this call may take. If this time has passed and the service(s) are not available an error will be thrown. (In milliseconds)
- Optional interval: number
  
  The time we will wait before once again checking if the service(s) are available (In milliseconds)
Returns Promise<WaitForServicesResult>
Inherited from Service.waitForServices
- Defined in node_modules/moleculer/index.d.ts:797

`Static` getVersionedFullName

getVersionedFullName(name: string, version?: string | number): string
Return a versioned full service name.
Parameters
- name: string
  
  The name
- Optional version: string | number
  
  The version
Returns string
Inherited from Service.getVersionedFullName
- Defined in node_modules/moleculer/index.d.ts:909

Class IndexerMs

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

broker: ServiceBroker

Returns IndexerMs

Properties

Promise

actions

broker

dependencies

fullName

logger

Protected main

metadata

name

originalSchema

schema

settings

Optional version

Static mainFactory

Methods

_init

Returns void

_start

Returns Promise<void>

_stop

Returns Promise<void>

applyMixins

Parameters

schema: ServiceSchema<ServiceSettingSchema>

Returns ServiceSchema<ServiceSettingSchema>

deleteAccount

Parameters

ctx: Context<AccountIndexerRequestArgs, {}, GenericObject>

Returns Promise<void>

emitLocalEventHandler

Parameters

eventName: string

Optional params: any

Optional opts: any

Returns any

getAccountState

Parameters

ctx: Context<GetAccountIndexingEntityStateRequestArgs, {}, GenericObject>

Returns Promise<undefined | AccountIndexerState>

getEntityPendingRequests

Parameters

ctx: Context<GetEntityPendingRequestsRequestArgs, {}, GenericObject>

Returns Promise<EntityRequest[]>

indexAccount

Parameters

ctx: Context<AccountIndexerRequestArgs, {}, GenericObject>

Returns Promise<void>

invokeDomainMethod

Parameters

ctx: Context<InvokeMethodRequestArgs, {}, GenericObject>

Returns Promise<unknown>

mergeSchemaActions

Parameters

src: GenericObject

target: GenericObject

Returns GenericObject

mergeSchemaDependencies

Parameters

src: GenericObject

target: GenericObject

Returns GenericObject

mergeSchemaEvents

Parameters

src: GenericObject

target: GenericObject

Returns GenericObject

mergeSchemaHooks

Parameters

`Protected` main

`Optional` version

`Static` mainFactory

`Optional` params: any

`Optional` opts: any

`Protected` parseServiceSchema

`Optional` timeout: number

`Optional` interval: number

`Static` getVersionedFullName

`Optional` version: string | number