Skip to main content

Class: ApiModule

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

Class: ApiModule

@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
  • baseUrlProvider: the provider of the base URL.

Hierarchy

Table of contents

Accessors

Methods

Constructors

Properties

Accessors

baseUrl

get baseUrl(): string

Description

The base URL of the API.

Returns

string

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


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(name, core, baseUrlProvider)

Parameters

NameType
namestring
coreCore
baseUrlProvider() => string

Overrides

Module.constructor

Properties

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


logger

Protected Readonly logger: LoggerController

Inherited from

Module.logger