Class: ApiModule<Events>

moralis-monorepo / @moralisweb3/common-core / ApiModule

Class: ApiModule<Events>

@moralisweb3/common-core.ApiModule

The base class of every Moralis Api class that gets registered as a module via MoralisModules It should always be created with:

• name: name of the module (should be unique)
• core: the Core instance
• baseUrl: the base url where of the api

Type parameters

Name	Type
Events	extends EventMap = any

Hierarchy

• Module<Events>

  ↳ ApiModule

Table of contents

Properties

• baseUrl
• name
• type
• core
• emitter
• logger

Methods

• cleanUp
• listen
• setup
• start

Constructors

• constructor

Properties

baseUrl

• Readonly baseUrl: string

---

name

• Readonly name: string

Inherited from

Module.name

---

type

• Readonly type: ModuleType = ModuleType.DEFAULT

Inherited from

Module.type

---

core

• Protected Readonly core: Core

Inherited from

Module.core

---

emitter

• Protected Readonly emitter: TypedEventEmitter<Events>

Inherited from

Module.emitter

---

logger

• Protected Readonly logger: LoggerController

Inherited from

Module.logger

Methods

cleanUp

▸ cleanUp(): void

Any cleanup that needs to be done for removing this module. It also should remove the module via this.core.modules.remove(this.name)

Returns

void

Inherited from

Module.cleanUp

---

listen

▸ listen<Event>(eventName, listener): () => TypedEventEmitter<Events>

Listen to an event, and returns a cleanup function

Type parameters

Name	Type
Event	extends string | number | symbol

Parameters

Name	Type
eventName	Event
listener	Events[Event]

Returns

fn

▸ (): TypedEventEmitter<Events>

Returns

TypedEventEmitter<Events>

Inherited from

Module.listen

---

setup

▸ Abstract setup(): void

Returns

void

Inherited from

Module.setup

---

start

▸ Abstract start(): void | Promise<void>

Start the module (if needed). This function can be used to initialize variables etc.

Returns

void | Promise<void>

Inherited from

Module.start

Constructors

constructor

• new ApiModule<Events>(name, core, baseUrl)

Type parameters

Name	Type
Events	extends EventMap = any

Parameters

Name	Type
name	string
core	Core
baseUrl	string

Overrides

Module.constructor