Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AppModule

description

The main module definition for the app. This module injects dependencies that are required for the common scope and enables some API endpoints as described below.

This scoped module currently features the following submodules:

Module Mongo collection(s) Routes Description
AccountsModule accounts /accounts Module with schedulers, collections and routes around dApp accounts.
AuthModule N/A /auth Module with schedulers, collections and routes around dApp authentication.
ChallengesModule authchallenges /auth/challenge Module with schedulers, collections and routes around authentication challenges.
since

v0.1.0

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static Private Readonly logger

logger: LogService = ...

LogService instance for this class.

access

private

static
readonly

Methods

Static checkConfiguration

  • checkConfiguration(): void

  • This method validates the dApp configuration object. It uses the AppConfiguration class to perform validations of all configuration fields that are used in this runtime.

    Note that this method will create an instance of the external {@link MongooseModule} to perform a validation of connectivity with the database.

    access

    public

    static
    throws

    {ConfigurationError} Given any error in configuration of the dApp.

    Returns void

    Returns blank given correct configuration.

Static register

  • This method initializes application modules around a DappConfig configuration object. We use {@link DynamicModule} from nest to register modules in the main (root) application module.

    Note that the AppModule itself injects some modules as well including DiscoveryAccountsModule, AuthModule and ChallengesModule which are necessary to the good functioning of the backend runtime.

    All other dependency injections are performed dynamically based on the configuration object.

    access

    public

    static

    Parameters

    Returns AbstractAppModule

    instance of this module

Generated using TypeDoc