Yggdrasil Module Base

Standard Utilities

In base module, there are some standard utilities that are used in many modules.

• Tracer: Log message to somewhere like database and console.
• Result: A type that represents a result of an operation. It can be Ok or Err. Usually used in REST API to represent the result of an operation.
• Expectation: Auto retry a function who returns TaskOption<T>. Or delay a function who returns Task<T>.

Module Requirements

Each module should have these dependencies:

• @yggdrasil-template/base: This module.
• fp-ts: Functional programming in TypeScript.
• drizzle-orm: ORM for TypeScript used in Yggdrasil Template.

A Yggdrasil module is a function that creates a module instance with the general dependencies and extra dependencies.

Usually, any module require a database access and need to log messages, so they are GeneralDependencies. But sometimes, a module may other extra dependencies like Redis, so they are ExtraDependencies.

Both GeneralDependencies and ExtraDependencies are optional for modules, but required for application code to create a module instance.

Module can also have some "static" functions, which don't need dependencies injected. They are usually pure utility functions.

Some modules may use Redis as dependency. In this case, use ioredis package.

export interface YggdrasilModule<I, EX extends ExtraDependencies | undefined> {
  (general: GeneralDependencies, extra: EX): I;
}