@morojs/moro

@morojs/moro / Moro

Class: Moro

Defined in: src/moro.ts:226

Extends

• EventEmitter

Constructors

Constructor

new Moro(options?, preloadedConfig?): Moro

Defined in: src/moro.ts:299

Parameters

options?

MoroOptions = {}

preloadedConfig?

Readonly<AppConfig>

Returns

Moro

Overrides

EventEmitter.constructor

Properties

captureRejections

static captureRejections: boolean

Defined in: node_modules/@types/node/events.d.ts:425

Value: boolean

Change the default captureRejections option on all new EventEmitter objects.

Since

v13.4.0, v12.16.0

Inherited from

EventEmitter.captureRejections

captureRejectionSymbol

readonly static captureRejectionSymbol: typeof captureRejectionSymbol

Defined in: node_modules/@types/node/events.d.ts:418

Value: Symbol.for('nodejs.rejection')

See how to write a custom rejection handler.

Since

v13.4.0, v12.16.0

Inherited from

EventEmitter.captureRejectionSymbol

defaultMaxListeners

static defaultMaxListeners: number

Defined in: node_modules/@types/node/events.d.ts:464

By default, a maximum of 10 listeners can be registered for any single event. This limit can be changed for individual EventEmitter instances using the emitter.setMaxListeners(n) method. To change the default for allEventEmitter instances, the events.defaultMaxListeners property can be used. If this value is not a positive number, a RangeError is thrown.

Take caution when setting the events.defaultMaxListeners because the change affects all EventEmitter instances, including those created before the change is made. However, calling emitter.setMaxListeners(n) still has precedence over events.defaultMaxListeners.

This is not a hard limit. The EventEmitter instance will allow more listeners to be added but will output a trace warning to stderr indicating that a "possible EventEmitter memory leak" has been detected. For any single EventEmitter, the emitter.getMaxListeners() and emitter.setMaxListeners() methods can be used to temporarily avoid this warning:

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
  // do stuff
  emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});

The --trace-warnings command-line flag can be used to display the stack trace for such warnings.

The emitted warning can be inspected with process.on('warning') and will have the additional emitter, type, and count properties, referring to the event emitter instance, the event's name and the number of attached listeners, respectively. Its name property is set to 'MaxListenersExceededWarning'.

Since

v0.11.2

Inherited from

EventEmitter.defaultMaxListeners

errorMonitor

readonly static errorMonitor: typeof errorMonitor

Defined in: node_modules/@types/node/events.d.ts:411

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

Since

v13.6.0, v12.17.0

Inherited from

EventEmitter.errorMonitor

Accessors

core

Get Signature

get core(): Moro

Defined in: src/moro.ts:1633

Returns

Moro

engine

Get Signature

get engine(): ServerKind

Defined in: src/moro.ts:1640

Returns

ServerKind

events

Get Signature

get events(): MoroEventBus

Defined in: src/moro.ts:1620

Returns

MoroEventBus

hooks

Get Signature

get hooks(): HookManager

Defined in: src/moro.ts:1628

Returns

HookManager

Methods

[captureRejectionSymbol]()?

optional [captureRejectionSymbol]<K>(error, event, ...args): void

Defined in: node_modules/@types/node/events.d.ts:103

Type Parameters

K

K

Parameters

error

Error

event

string | symbol

args

...AnyRest

Returns

void

Inherited from

EventEmitter.[captureRejectionSymbol]

addBulkToQueue()

addBulkToQueue<T>(queueName, jobs): Promise<any[]>

Defined in: src/moro.ts:3791

Add multiple jobs to a queue in bulk

Type Parameters

T

T = any

Parameters

queueName

string

jobs

object[]

Returns

Promise<any[]>

Example

await app.addBulkToQueue('emails', [
  { data: { to: 'user1@example.com' }, options: { priority: 1 } },
  { data: { to: 'user2@example.com' }, options: { priority: 2 } }
]);

addListener()

addListener<K>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:642

Alias for emitter.on(eventName, listener).

Type Parameters

K

K

Parameters

eventName

string | symbol

listener

(...args) => void

Returns

this

Since

v0.1.26

Inherited from

EventEmitter.addListener

addToQueue()

addToQueue<T>(queueName, data, options?): Promise<any>

Defined in: src/moro.ts:3767

Add a job to a queue

Type Parameters

T

T = any

Parameters

queueName

string

data

T

options?

any

Returns

Promise<any>

Example

await app.addToQueue('emails', {
  to: 'user@example.com',
  subject: 'Welcome'
}, {
  priority: 10,
  delay: 5000
});

all()

all(path, handler, options?): this

Defined in: src/moro.ts:636

Register a handler for all HTTP methods on the given path (Express-compatible). Handler is required — unlike the single-method registrations, there's no builder form since all() fans out across methods.

Parameters

path

string

handler

StaticBody | ((req, res) => any)

options?

any

Returns

this

cleanQueue()

cleanQueue(queueName, gracePeriod, status?): Promise<void>

Defined in: src/moro.ts:3925

Clean old jobs from a queue

Parameters

queueName

string

gracePeriod

number

status?

"completed" | "failed" | "waiting" | "active" | "delayed" | "paused"

Returns

Promise<void>

close()

close(): Promise<void>

Defined in: src/moro.ts:2784

Returns

Promise<void>

createGrpcClient()

createGrpcClient(protoPath, serviceName, address, options?): Promise<GrpcClient>

Defined in: src/moro.ts:3608

Create a gRPC client for calling remote services

Parameters

protoPath

string

serviceName

string

address

string

options?

Partial<GrpcClientOptions>

Returns

Promise<GrpcClient>

Example

const client = await app.createGrpcClient(
  './proto/users.proto',
  'UserService',
  'localhost:50051'
);

const user = await client.getUser({ id: '123' });

database()

database(adapter): Moro

Defined in: src/moro.ts:950

Parameters

adapter

any

Returns

Moro

decorate()

decorate(name, value): this

Defined in: src/moro.ts:912

Decorate the app instance itself.

Parameters

name

string

value

any

Returns

this

decorateReply()

decorateReply(name, value): this

Defined in: src/moro.ts:897

Decorate every response with a property (see decorateRequest).

Parameters

name

string

value

any

Returns

this

decorateRequest()

decorateRequest(name, value): this

Defined in: src/moro.ts:887

Decorate every request with a property. The value is assigned by reference to each incoming request (use a per-request middleware to set per-request values).

Parameters

name

string

value

any

Returns

this

decorateResponse()

decorateResponse(name, value): this

Defined in: src/moro.ts:907

Alias for decorateReply (Fastify-compatible name).

Parameters

name

string

value

any

Returns

this

delete()

Call Signature

delete(path): RouteBuilder

Defined in: src/moro.ts:559

Parameters

path

string

Returns

RouteBuilder

Call Signature

delete(path, handler, options?): this

Defined in: src/moro.ts:560

Parameters

path

string

handler

StaticBody | ((req, res) => any)

options?

any

Returns

this

emit()

emit<K>(eventName, ...args): boolean

Defined in: node_modules/@types/node/events.d.ts:904

Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

Returns true if the event had listeners, false otherwise.

import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();

// First listener
myEmitter.on('event', function firstListener() {
  console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
  console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
  const parameters = args.join(', ');
  console.log(`event with parameters ${parameters} in third listener`);
});

console.log(myEmitter.listeners('event'));

myEmitter.emit('event', 1, 2, 3, 4, 5);

// Prints:
// [
//   [Function: firstListener],
//   [Function: secondListener],
//   [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener

Type Parameters

K

K

Parameters

eventName

string | symbol

args

...AnyRest

Returns

boolean

Since

v0.1.26

Inherited from

EventEmitter.emit

enableDocs()

enableDocs(config): void

Defined in: src/moro.ts:734

Parameters

config

DocsConfig

Returns

void

eventNames()

eventNames(): (string | symbol)[]

Defined in: node_modules/@types/node/events.d.ts:967

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

import { EventEmitter } from 'node:events';

const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});

const sym = Symbol('symbol');
myEE.on(sym, () => {});

console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]

Returns

(string | symbol)[]

Since

v6.0.0

Inherited from

EventEmitter.eventNames

executeOnWorker()

executeOnWorker<T>(task): Promise<T>

Defined in: src/moro.ts:3362

Execute a task on worker threads (CPU-intensive operations)

Type Parameters

T

T = any

Parameters

task

WorkerTask

Task to execute

Returns

Promise<T>

Promise resolving to task result

Example

// JWT verification (CPU-intensive)
const payload = await app.executeOnWorker({
  id: 'jwt-verify-123',
  type: 'jwt:verify',
  data: { token, secret }
});

// Heavy computation
const result = await app.executeOnWorker({
  id: 'compute-456',
  type: 'computation:heavy',
  data: { iterations: 1000000 }
});

forceCleanup()

forceCleanup(): void

Defined in: src/moro.ts:1667

Returns

void

get()

Call Signature

get(path): RouteBuilder

Defined in: src/moro.ts:502

Parameters

path

string

Returns

RouteBuilder

Call Signature

get(path, handler, options?): this

Defined in: src/moro.ts:503

Parameters

path

string

handler

StaticBody | ((req, res) => any)

options?

any

Returns

this

getComputeWorker()

getComputeWorker(): Promise<{ heavy: (data) => Promise<any>; transformJSON: (data, transformer) => Promise<any>; } | null>

Defined in: src/moro.ts:3398

Heavy computation operations using worker threads

Returns

Promise<{ heavy: (data) => Promise<any>; transformJSON: (data, transformer) => Promise<any>; } | null>

getConfig()

getConfig(): AppConfig

Defined in: src/moro.ts:471

Get configuration object

Returns

AppConfig

getContainer()

getContainer(): Container

Defined in: src/moro.ts:1662

Returns

Container

getCryptoWorker()

getCryptoWorker(): Promise<{ hash: (data, algorithm?) => Promise<string>; } | null>

Defined in: src/moro.ts:3391

Crypto operations using worker threads

Returns

Promise<{ hash: (data, algorithm?) => Promise<string>; } | null>

getDocsJSON()

getDocsJSON(): string

Defined in: src/moro.ts:747

Returns

string

getDocsYAML()

getDocsYAML(): string

Defined in: src/moro.ts:752

Returns

string

getErrorHandler()

getErrorHandler(): ((err, req, res) => any) | undefined

Defined in: src/moro.ts:878

Internal: retrieve the registered error handler (used by the HTTP server).

Returns

((err, req, res) => any) | undefined

getGraphQLSchema()

getGraphQLSchema(): Promise<any>

Defined in: src/moro.ts:3331

Get GraphQL schema (if configured)

Returns

Promise<any>

getGraphQLStats()

getGraphQLStats(): Promise<any>

Defined in: src/moro.ts:3405

Get GraphQL stats

Returns

Promise<any>

getGrpcServices()

getGrpcServices(): any

Defined in: src/moro.ts:3657

Get list of registered gRPC services

Returns

any

getGrpcStats()

getGrpcStats(): any

Defined in: src/moro.ts:3646

Get gRPC statistics

Returns

any

getHandler()

getHandler(): any

Defined in: src/moro.ts:1419

Returns

any

getJob()

getJob(queueName, jobId): Promise<any>

Defined in: src/moro.ts:3854

Get a specific job from a queue

Parameters

queueName

string

jobId

string

Returns

Promise<any>

getJobHealth()

getJobHealth(jobId?): JobHealth | JobHealth[]

Defined in: src/moro.ts:3082

Get job health status

Parameters

jobId?

string

Returns

JobHealth | JobHealth[]

getJobMetrics()

getJobMetrics(jobId): JobMetrics | null

Defined in: src/moro.ts:3071

Get job metrics

Parameters

jobId

string

Returns

JobMetrics | null

getJobs()

getJobs(queueName, status?, start?, end?): Promise<any[]>

Defined in: src/moro.ts:3865

Get jobs from a queue by status

Parameters

queueName

string

status?

"completed" | "failed" | "waiting" | "active" | "delayed" | "paused"

start?

number = 0

end?

number = -1

Returns

Promise<any[]>

getJobStats()

getJobStats(): SchedulerStats | null

Defined in: src/moro.ts:3107

Get scheduler statistics

Returns

SchedulerStats | null

getJwtWorker()

getJwtWorker(): Promise<{ sign: (payload, secret, options?) => Promise<string>; verify: (token, secret, options?) => Promise<any>; } | null>

Defined in: src/moro.ts:3384

JWT operations using worker threads (prevents event loop blocking)

Returns

Promise<{ sign: (payload, secret, options?) => Promise<string>; verify: (token, secret, options?) => Promise<any>; } | null>

getMailTemplateEngine()

getMailTemplateEngine(): any

Defined in: src/moro.ts:4156

Get mail template engine for advanced usage

Returns

any

getMaxListeners()

getMaxListeners(): number

Defined in: node_modules/@types/node/events.d.ts:819

Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

Returns

number

Since

v1.0.0

Inherited from

EventEmitter.getMaxListeners

getOpenAPISpec()

getOpenAPISpec(): OpenAPISpec

Defined in: src/moro.ts:742

Returns

OpenAPISpec

getQueueNames()

getQueueNames(): string[]

Defined in: src/moro.ts:3940

Get all registered queue names

Returns

string[]

getQueueStatus()

getQueueStatus(queueName): Promise<any>

Defined in: src/moro.ts:3843

Get queue status

Parameters

queueName

string

Returns

Promise<any>

getRuntime()

getRuntime(): RuntimeAdapter

Defined in: src/moro.ts:478

Get runtime adapter

Returns

RuntimeAdapter

getRuntimeType()

getRuntimeType(): RuntimeType

Defined in: src/moro.ts:485

Get runtime type

Returns

RuntimeType

getSchedulerHealth()

getSchedulerHealth(): { jobs: JobHealth[]; message?: string; stats: SchedulerStats; status: JobHealthStatus; unhealthyJobCount: number; } | { jobs: never[]; message: string; stats: null; status: "unknown"; unhealthyJobCount: number; }

Defined in: src/moro.ts:3118

Get overall scheduler health

Returns

{ jobs: JobHealth[]; message?: string; stats: SchedulerStats; status: JobHealthStatus; unhealthyJobCount: number; } | { jobs: never[]; message: string; stats: null; status: "unknown"; unhealthyJobCount: number; }

getServerKind()

getServerKind(): ServerKind

Defined in: src/moro.ts:1657

Returns

ServerKind

getWorkerManager()

getWorkerManager(): Promise<WorkerThreadsFacade>

Defined in: src/moro.ts:3369

Get worker manager instance for advanced usage

Returns

Promise<WorkerThreadsFacade>

getWorkerStats()

getWorkerStats(): Promise<WorkerStats | null>

Defined in: src/moro.ts:3377

Get worker thread statistics

Returns

Promise<WorkerStats | null>

graphqlInit()

graphqlInit(options): this

Defined in: src/moro.ts:3195

Configure GraphQL endpoint (synchronous, lazy initialization)

Parameters

options

GraphQLOptions

GraphQL configuration options

Returns

this

Example

// Using type definitions and resolvers
app.graphqlInit({
  typeDefs: `
    type Query {
      hello: String
      users: [User]
    }
    type User {
      id: ID!
      name: String!
    }
  `,
  resolvers: {
    Query: {
      hello: () => 'Hello World!',
      users: () => [{ id: '1', name: 'Alice' }]
    }
  }
});

// Using Pothos schema builder
import SchemaBuilder from '@pothos/core';

const builder = new SchemaBuilder();
builder.queryType({
  fields: (t) => ({
    hello: t.string({ resolve: () => 'Hello World!' })
  })
});

app.graphqlInit({
  pothosSchema: builder
});

group()

group(prefix, callback): this

Defined in: src/moro.ts:655

Parameters

prefix

string

callback

(group) => void

Returns

this

grpcInit()

grpcInit(options?): this

Defined in: src/moro.ts:3436

Configure gRPC server (synchronous, lazy initialization)

Parameters

options?

GrpcOptions = {}

Returns

this

Example

app.grpcInit({
  port: 50051,
  host: '0.0.0.0',
  adapter: 'grpc-js',
  enableHealthCheck: true,
  enableReflection: true
});

grpcService()

grpcService(protoPath, serviceName, implementation, packageName?): Promise<void>

Defined in: src/moro.ts:3512

Register a gRPC service from a proto file

Parameters

protoPath

string

serviceName

string

implementation

ServiceImplementation

packageName?

string

Returns

Promise<void>

Example

app.grpcService('./proto/users.proto', 'UserService', {
  getUser: async (call, callback) => {
    const user = await db.users.findById(call.request.id);
    callback(null, user);
  },
  listUsers: async (call) => {
    for (const user of users) {
      call.write(user);
    }
    call.end();
  }
});

hasMailSystem()

hasMailSystem(): boolean

Defined in: src/moro.ts:4167

Check if mail system is configured

Returns

boolean

hasQueue()

hasQueue(queueName): boolean

Defined in: src/moro.ts:3957

Check if a queue is registered

Parameters

queueName

string

Returns

boolean

head()

Call Signature

head(path): RouteBuilder

Defined in: src/moro.ts:597

Parameters

path

string

Returns

RouteBuilder

Call Signature

head(path, handler, options?): this

Defined in: src/moro.ts:598

Parameters

path

string

handler

StaticBody | ((req, res) => any)

options?

any

Returns

this

initializeAutoDiscoveryNow()

initializeAutoDiscoveryNow(): Promise<void>

Defined in: src/moro.ts:1273

Returns

Promise<void>

initModules()

initModules(options?): void

Defined in: src/moro.ts:1324

Parameters

options?

failOnError?

boolean

ignorePatterns?

string[]

loadingStrategy?

"eager" | "lazy" | "conditional"

loadOrder?

"custom" | "alphabetical" | "dependency"

maxDepth?

number

paths?

string[]

patterns?

string[]

recursive?

boolean

watchForChanges?

boolean

Returns

void

job()

job(name, schedule, handler, options?): string

Defined in: src/moro.ts:2983

Register a background job with cron or interval schedule

Parameters

name

string

Job name (used for identification)

schedule

string | JobSchedule

Cron expression, interval string ('5m', '1h'), or schedule object

handler

JobFunction

Job function to execute

options?

SimpleJobOptions = {}

Job configuration options

Returns

string

Job ID for management

Example

// Cron schedule
app.job('cleanup', '0 2 * * *', async () => {
  await cleanupOldData();
});

// Interval schedule
app.job('health-check', '5m', async (ctx) => {
  console.log('Health check', ctx.executionId);
});

// Advanced options
app.job('report', '@daily', generateReport, {
  timeout: 60000,
  maxRetries: 3,
  onError: (ctx, error) => console.error('Job failed', error)
});

listen()

Call Signature

listen(callback?): void

Defined in: src/moro.ts:1090

Parameters

callback?

() => void

Returns

void

Call Signature

listen(port, callback?): void

Defined in: src/moro.ts:1091

Parameters

port

number

callback?

() => void

Returns

void

Call Signature

listen(port, host, callback?): void

Defined in: src/moro.ts:1092

Parameters

port

number

host

string

callback?

() => void

Returns

void

listenerCount()

listenerCount<K>(eventName, listener?): number

Defined in: node_modules/@types/node/events.d.ts:913

Returns the number of listeners listening for the event named eventName. If listener is provided, it will return how many times the listener is found in the list of the listeners of the event.

Type Parameters

K

K

Parameters

eventName

string | symbol

The name of the event being listened for

listener?

Function

The event handler function

Returns

number

Since

v3.2.0

Inherited from

EventEmitter.listenerCount

listeners()

listeners<K>(eventName): Function[]

Defined in: node_modules/@types/node/events.d.ts:832

Returns a copy of the array of listeners for the event named eventName.

server.on('connection', (stream) => {
  console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]

Type Parameters

K

K

Parameters

eventName

string | symbol

Returns

Function[]

Since

v0.1.26

Inherited from

EventEmitter.listeners

loadModule()

loadModule(moduleOrPath): Promise<Moro>

Defined in: src/moro.ts:918

Parameters

moduleOrPath

string | ModuleConfig

Returns

Promise<Moro>

loadRoutes()

loadRoutes(dir): Promise<void>

Defined in: src/moro.ts:678

Auto-load route files from a directory.

Loads top-level .ts/.js files and index.ts from subdirectories. Other files in subdirectories are ignored — they get pulled in when their index.ts imports them.

Parameters

dir

string

Returns

Promise<void>

Example

await app.loadRoutes('./src/routes');

// routes/
//   health.ts         → loaded
//   auth/
//     index.ts        → loaded
//     actions.ts      → ignored (imported by index.ts)

mailInit()

mailInit(config): this

Defined in: src/moro.ts:4000

Configure mail system (synchronous, lazy initialization)

Parameters

config

MailConfig

Returns

this

Example

// Using Nodemailer (SMTP) - chainable, no await needed!
app.mailInit({
  adapter: 'nodemailer',
  from: { name: 'My App', email: 'noreply@myapp.com' },
  connection: {
    host: 'smtp.gmail.com',
    port: 587,
    secure: false,
    auth: { user: process.env.EMAIL_USER, pass: process.env.EMAIL_PASSWORD }
  },
  templates: { path: './emails', engine: 'moro', cache: true }
});

// Using SendGrid
app.mailInit({
  adapter: 'sendgrid',
  from: 'noreply@myapp.com',
  connection: { apiKey: process.env.SENDGRID_API_KEY }
});

off()

off<K>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:792

Alias for emitter.removeListener().

Type Parameters

K

K

Parameters

eventName

string | symbol

listener

(...args) => void

Returns

this

Since

v10.0.0

Inherited from

EventEmitter.off

on()

on<K>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:674

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

server.on('connection', (stream) => {
  console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Type Parameters

K

K

Parameters

eventName

string | symbol

The name of the event.

listener

(...args) => void

The callback function

Returns

this

Since

v0.1.101

Inherited from

EventEmitter.on

once()

once<K>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:704

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

server.once('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the event listener to the beginning of the listeners array.

import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
//   b
//   a

Type Parameters

K

K

Parameters

eventName

string | symbol

The name of the event.

listener

(...args) => void

The callback function

Returns

this

Since

v0.3.0

Inherited from

EventEmitter.once

onClose()

onClose(fn): this

Defined in: src/moro.ts:857

Register a shutdown hook. Hooks run (in registration order) during app.close(), before Moro tears down its own subsystems. Use for closing DB pools, external connections, flushing metrics, etc.

Parameters

fn

() => any

Returns

this

options()

Call Signature

options(path): RouteBuilder

Defined in: src/moro.ts:614

Parameters

path

string

Returns

RouteBuilder

Call Signature

options(path, handler, options?): this

Defined in: src/moro.ts:615

Parameters

path

string

handler

StaticBody | ((req, res) => any)

options?

any

Returns

this

patch()

Call Signature

patch(path): RouteBuilder

Defined in: src/moro.ts:578

Parameters

path

string

Returns

RouteBuilder

Call Signature

patch(path, handler, options?): this

Defined in: src/moro.ts:579

Parameters

path

string

handler

StaticBody | ((req, res) => any)

options?

any

Returns

this

pauseQueue()

pauseQueue(queueName): Promise<void>

Defined in: src/moro.ts:3903

Pause a queue

Parameters

queueName

string

Returns

Promise<void>

plugin()

plugin(middleware, options?): Promise<Moro>

Defined in: src/moro.ts:848

Parameters

middleware

any

options?

any

Returns

Promise<Moro>

post()

Call Signature

post(path): RouteBuilder

Defined in: src/moro.ts:521

Parameters

path

string

Returns

RouteBuilder

Call Signature

post(path, handler, options?): this

Defined in: src/moro.ts:522

Parameters

path

string

handler

StaticBody | ((req, res) => any)

options?

any

Returns

this

prependListener()

prependListener<K>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:931

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

server.prependListener('connection', (stream) => {
  console.log('someone connected!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters

K

K

Parameters

eventName

string | symbol

The name of the event.

listener

(...args) => void

The callback function

Returns

this

Since

v6.0.0

Inherited from

EventEmitter.prependListener

prependOnceListener()

prependOnceListener<K>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:947

Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this listener is removed, and then invoked.

server.prependOnceListener('connection', (stream) => {
  console.log('Ah, we have our first user!');
});

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters

K

K

Parameters

eventName

string | symbol

The name of the event.

listener

(...args) => void

The callback function

Returns

this

Since

v6.0.0

Inherited from

EventEmitter.prependOnceListener

processQueue()

processQueue<R>(queueName, concurrencyOrHandler, handler?): Promise<void>

Defined in: src/moro.ts:3823

Register a processor for a queue

Type Parameters

R

R = any

Parameters

queueName

string

concurrencyOrHandler

number | ((job) => Promise<R>)

handler?

(job) => Promise<R>

Returns

Promise<void>

Example

// Simple processor
app.processQueue('emails', async (job) => {
  await sendEmail(job.data);
});

// With concurrency
app.processQueue('images', 3, async (job) => {
  await processImage(job.data);
});

put()

Call Signature

put(path): RouteBuilder

Defined in: src/moro.ts:540

Parameters

path

string

Returns

RouteBuilder

Call Signature

put(path, handler, options?): this

Defined in: src/moro.ts:541

Parameters

path

string

handler

StaticBody | ((req, res) => any)

options?

any

Returns

this

~~queue()~~

queue(name, options): Promise<void>

Defined in: src/moro.ts:3730

Parameters

name

string

options

any

Returns

Promise<void>

Deprecated

Use queueInit() instead

queueInit()

queueInit(name, options): this

Defined in: src/moro.ts:3680

Initialize queue system (synchronous for first queue, subsequent queues added immediately)

Parameters

name

string

options

any

Returns

this

Example

app.queueInit('emails', {
  adapter: 'bull',
  connection: {
    host: 'localhost',
    port: 6379
  },
  concurrency: 5
});

rawListeners()

rawListeners<K>(eventName): Function[]

Defined in: node_modules/@types/node/events.d.ts:863

Returns a copy of the array of listeners for the event named eventName, including any wrappers (such as those created by .once()).

import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));

// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];

// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();

// Logs "log once" to the console and removes the listener
logFnWrapper();

emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');

// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');

Type Parameters

K

K

Parameters

eventName

string | symbol

Returns

Function[]

Since

v9.4.0

Inherited from

EventEmitter.rawListeners

refreshDocs()

refreshDocs(): void

Defined in: src/moro.ts:757

Returns

void

reloadTLS()

reloadTLS(ssl?): Promise<void>

Defined in: src/moro.ts:1652

Rotate the TLS certificate/key on the running listener without a restart. With no argument the key/cert files from server.ssl are re-read; with one, the given material (either ssl shape) replaces them. The new pair is validated first, so a bad file leaves the current certificate serving and rejects. Connections already established are untouched. server.ssl.watch calls this automatically when the files change.

Parameters

ssl?

SSLConfigInput

Returns

Promise<void>

removeAllListeners()

removeAllListeners(eventName?): this

Defined in: node_modules/@types/node/events.d.ts:803

Removes all listeners, or those of the specified eventName.

It is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

eventName?

string | symbol

Returns

this

Since

v0.1.26

Inherited from

EventEmitter.removeAllListeners

removeJob()

removeJob(queueName, jobId): Promise<void>

Defined in: src/moro.ts:3881

Remove a job from a queue

Parameters

queueName

string

jobId

string

Returns

Promise<void>

removeListener()

removeListener<K>(eventName, listener): this

Defined in: node_modules/@types/node/events.d.ts:787

Removes the specified listener from the listener array for the event named eventName.

const callback = (stream) => {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);

removeListener() will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener() must be called multiple times to remove each instance.

Once an event is emitted, all listeners attached to it at the time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them fromemit() in progress. Subsequent events behave as expected.

import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();

const callbackA = () => {
  console.log('A');
  myEmitter.removeListener('event', callbackB);
};

const callbackB = () => {
  console.log('B');
};

myEmitter.on('event', callbackA);

myEmitter.on('event', callbackB);

// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
//   A
//   B

// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
//   A

Because listeners are managed using an internal array, calling this will change the position indices of any listener registered after the listener being removed. This will not impact the order in which listeners are called, but it means that any copies of the listener array as returned by the emitter.listeners() method will need to be recreated.

When a single function has been added as a handler multiple times for a single event (as in the example below), removeListener() will remove the most recently added instance. In the example the once('ping') listener is removed:

import { EventEmitter } from 'node:events';
const ee = new EventEmitter();

function pong() {
  console.log('pong');
}

ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);

ee.emit('ping');
ee.emit('ping');

Returns a reference to the EventEmitter, so that calls can be chained.

Type Parameters

K

K

Parameters

eventName

string | symbol

listener

(...args) => void

Returns

this

Since

v0.1.26

Inherited from

EventEmitter.removeListener

resumeQueue()

resumeQueue(queueName): Promise<void>

Defined in: src/moro.ts:3914

Resume a paused queue

Parameters

queueName

string

Returns

Promise<void>

retryJob()

retryJob(queueName, jobId): Promise<void>

Defined in: src/moro.ts:3892

Retry a failed job

Parameters

queueName

string

jobId

string

Returns

Promise<void>

route()

route(schema): void

Defined in: src/moro.ts:649

Parameters

schema

RouteSchema

Returns

void

sendBulkMail()

sendBulkMail(options): Promise<MailResult[]>

Defined in: src/moro.ts:4133

Send multiple emails in bulk

Parameters

options

MailOptions[]

Returns

Promise<MailResult[]>

Example

await app.sendBulkMail([
  { to: 'user1@example.com', subject: 'Hello', text: 'Hi!' },
  { to: 'user2@example.com', subject: 'Hello', text: 'Hi!' }
]);

sendMail()

sendMail(options): Promise<MailResult>

Defined in: src/moro.ts:4100

Send an email

Parameters

options

MailOptions

Returns

Promise<MailResult>

Example

// Simple email
await app.sendMail({
  to: 'user@example.com',
  subject: 'Welcome',
  text: 'Welcome to our app!'
});

// With template
await app.sendMail({
  to: 'user@example.com',
  subject: 'Password Reset',
  template: 'password-reset',
  data: { name: 'John', resetUrl: 'https://myapp.com/reset/token123' }
});

// With attachments
await app.sendMail({
  to: 'user@example.com',
  subject: 'Invoice',
  template: 'invoice',
  data: { invoice },
  attachments: [{ filename: 'invoice.pdf', content: pdfBuffer }]
});

setErrorHandler()

setErrorHandler(fn): this

Defined in: src/moro.ts:867

Register a global error handler. Invoked when a middleware/handler throws or calls next(err), and no 4-arg error middleware has already handled it. Coexists with Express-style 4-arg error middlewares.

Parameters

fn

(err, req, res) => any

Returns

this

setJobEnabled()

setJobEnabled(jobId, enabled): boolean

Defined in: src/moro.ts:3038

Enable or disable a registered job

Parameters

jobId

string

enabled

boolean

Returns

boolean

setMaxListeners()

setMaxListeners(n): this

Defined in: node_modules/@types/node/events.d.ts:813

By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.

Returns a reference to the EventEmitter, so that calls can be chained.

Parameters

n

number

Returns

this

Since

v0.3.5

Inherited from

EventEmitter.setMaxListeners

startGrpc()

startGrpc(): Promise<void>

Defined in: src/moro.ts:3549

Start gRPC server Called automatically by listen() if gRPC is configured

Returns

Promise<void>

stopGrpc()

stopGrpc(): Promise<void>

Defined in: src/moro.ts:3579

Stop gRPC server gracefully

Returns

Promise<void>

triggerJob()

triggerJob(jobId, metadata?): Promise<any>

Defined in: src/moro.ts:3049

Manually trigger a job execution

Parameters

jobId

string

metadata?

Record<string, any>

Returns

Promise<any>

unregisterJob()

unregisterJob(jobId): boolean

Defined in: src/moro.ts:3060

Unregister a job

Parameters

jobId

string

Returns

boolean

use()

use(middlewareOrFunction, config?): Promise<Moro>

Defined in: src/moro.ts:762

Parameters

middlewareOrFunction

any

config?

any

Returns

Promise<Moro>

verifyMail()

verifyMail(): Promise<boolean>

Defined in: src/moro.ts:4143

Verify mail adapter connection

Returns

Promise<boolean>

websocket()

websocket(namespace, handlers, options?): Moro

Defined in: src/moro.ts:967

Parameters

namespace

string

handlers

Record<string, CallableFunction>

options?

WebSocketNamespaceOptions = {}

Returns

Moro

addAbortListener()

static addAbortListener(signal, resource): Disposable

Defined in: node_modules/@types/node/events.d.ts:403

Listens once to the abort event on the provided signal.

Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change this since it would violate the web standard. Additionally, the original API makes it easy to forget to remove listeners.

This API allows safely using AbortSignals in Node.js APIs by solving these two issues by listening to the event such that stopImmediatePropagation does not prevent the listener from running.

Returns a disposable so that it may be unsubscribed from more easily.

import { addAbortListener } from 'node:events';

function example(signal) {
  let disposable;
  try {
    signal.addEventListener('abort', (e) => e.stopImmediatePropagation());
    disposable = addAbortListener(signal, (e) => {
      // Do something when signal is aborted.
    });
  } finally {
    disposable?.[Symbol.dispose]();
  }
}

Parameters

signal

AbortSignal

resource

(event) => void

Returns

Disposable

Disposable that removes the abort listener.

Since

v20.5.0

Inherited from

EventEmitter.addAbortListener

getEventListeners()

static getEventListeners(emitter, name): Function[]

Defined in: node_modules/@types/node/events.d.ts:325

Returns a copy of the array of listeners for the event named eventName.

For EventEmitters this behaves exactly the same as calling .listeners on the emitter.

For EventTargets this is the only way to get the event listeners for the event target. This is useful for debugging and diagnostic purposes.

import { getEventListeners, EventEmitter } from 'node:events';

{
  const ee = new EventEmitter();
  const listener = () => console.log('Events are fun');
  ee.on('foo', listener);
  console.log(getEventListeners(ee, 'foo')); // [ [Function: listener] ]
}
{
  const et = new EventTarget();
  const listener = () => console.log('Events are fun');
  et.addEventListener('foo', listener);
  console.log(getEventListeners(et, 'foo')); // [ [Function: listener] ]
}

Parameters

emitter

EventEmitter<DefaultEventMap> | EventTarget

name

string | symbol

Returns

Function[]

Since

v15.2.0, v14.17.0

Inherited from

EventEmitter.getEventListeners

getMaxListeners()

static getMaxListeners(emitter): number

Defined in: node_modules/@types/node/events.d.ts:354

Returns the currently set max amount of listeners.

For EventEmitters this behaves exactly the same as calling .getMaxListeners on the emitter.

For EventTargets this is the only way to get the max event listeners for the event target. If the number of event handlers on a single EventTarget exceeds the max set, the EventTarget will print a warning.

import { getMaxListeners, setMaxListeners, EventEmitter } from 'node:events';

{
  const ee = new EventEmitter();
  console.log(getMaxListeners(ee)); // 10
  setMaxListeners(11, ee);
  console.log(getMaxListeners(ee)); // 11
}
{
  const et = new EventTarget();
  console.log(getMaxListeners(et)); // 10
  setMaxListeners(11, et);
  console.log(getMaxListeners(et)); // 11
}

Parameters

emitter

EventEmitter<DefaultEventMap> | EventTarget

Returns

number

Since

v19.9.0

Inherited from

EventEmitter.getMaxListeners

~~listenerCount()~~

static listenerCount(emitter, eventName): number

Defined in: node_modules/@types/node/events.d.ts:297

A class method that returns the number of listeners for the given eventName registered on the given emitter.

import { EventEmitter, listenerCount } from 'node:events';

const myEmitter = new EventEmitter();
myEmitter.on('event', () => {});
myEmitter.on('event', () => {});
console.log(listenerCount(myEmitter, 'event'));
// Prints: 2

Parameters

emitter

EventEmitter

The emitter to query

eventName

string | symbol

The event name

Returns

number

Since

v0.9.12

Deprecated

Since v3.2.0 - Use listenerCount instead.

Inherited from

EventEmitter.listenerCount

on()

Call Signature

static on(emitter, eventName, options?): AsyncIterator<any[]>

Defined in: node_modules/@types/node/events.d.ts:270

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
  ee.emit('foo', 'bar');
  ee.emit('foo', 42);
});

for await (const event of on(ee, 'foo')) {
  // The execution of this inner block is synchronous and it
  // processes one event at a time (even with await). Do not use
  // if concurrent execution is required.
  console.log(event); // prints ['bar'] [42]
}
// Unreachable here

Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.

An AbortSignal can be used to cancel waiting on events:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ac = new AbortController();

(async () => {
  const ee = new EventEmitter();

  // Emit later on
  process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
  });

  for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
  }
  // Unreachable here
})();

process.nextTick(() => ac.abort());

Use the close option to specify an array of event names that will end the iteration:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
  ee.emit('foo', 'bar');
  ee.emit('foo', 42);
  ee.emit('close');
});

for await (const event of on(ee, 'foo', { close: ['close'] })) {
  console.log(event); // prints ['bar'] [42]
}
// the loop will exit after 'close' is emitted
console.log('done'); // prints 'done'

Parameters

emitter

EventEmitter

eventName

string | symbol

options?

StaticEventEmitterIteratorOptions

Returns

AsyncIterator<any[]>

An AsyncIterator that iterates eventName events emitted by the emitter

Since

v13.6.0, v12.16.0

Inherited from

EventEmitter.on

Call Signature

static on(emitter, eventName, options?): AsyncIterator<any[]>

Defined in: node_modules/@types/node/events.d.ts:275

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
  ee.emit('foo', 'bar');
  ee.emit('foo', 42);
});

for await (const event of on(ee, 'foo')) {
  // The execution of this inner block is synchronous and it
  // processes one event at a time (even with await). Do not use
  // if concurrent execution is required.
  console.log(event); // prints ['bar'] [42]
}
// Unreachable here

Returns an AsyncIterator that iterates eventName events. It will throw if the EventEmitter emits 'error'. It removes all listeners when exiting the loop. The value returned by each iteration is an array composed of the emitted event arguments.

An AbortSignal can be used to cancel waiting on events:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ac = new AbortController();

(async () => {
  const ee = new EventEmitter();

  // Emit later on
  process.nextTick(() => {
    ee.emit('foo', 'bar');
    ee.emit('foo', 42);
  });

  for await (const event of on(ee, 'foo', { signal: ac.signal })) {
    // The execution of this inner block is synchronous and it
    // processes one event at a time (even with await). Do not use
    // if concurrent execution is required.
    console.log(event); // prints ['bar'] [42]
  }
  // Unreachable here
})();

process.nextTick(() => ac.abort());

Use the close option to specify an array of event names that will end the iteration:

import { on, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

// Emit later on
process.nextTick(() => {
  ee.emit('foo', 'bar');
  ee.emit('foo', 42);
  ee.emit('close');
});

for await (const event of on(ee, 'foo', { close: ['close'] })) {
  console.log(event); // prints ['bar'] [42]
}
// the loop will exit after 'close' is emitted
console.log('done'); // prints 'done'

Parameters

emitter

EventTarget

eventName

string

options?

StaticEventEmitterIteratorOptions

Returns

AsyncIterator<any[]>

An AsyncIterator that iterates eventName events emitted by the emitter

Since

v13.6.0, v12.16.0

Inherited from

EventEmitter.on

once()

Call Signature

static once(emitter, eventName, options?): Promise<any[]>

Defined in: node_modules/@types/node/events.d.ts:184

Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

import { once, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

process.nextTick(() => {
  ee.emit('myevent', 42);
});

const [value] = await once(ee, 'myevent');
console.log(value);

const err = new Error('kaboom');
process.nextTick(() => {
  ee.emit('error', err);
});

try {
  await once(ee, 'myevent');
} catch (err) {
  console.error('error happened', err);
}

The special handling of the 'error' event is only used when events.once() is used to wait for another event. If events.once() is used to wait for the 'error' event itself, then it is treated as any other kind of event without special handling:

import { EventEmitter, once } from 'node:events';

const ee = new EventEmitter();

once(ee, 'error')
  .then(([err]) => console.log('ok', err.message))
  .catch((err) => console.error('error', err.message));

ee.emit('error', new Error('boom'));

// Prints: ok boom

An AbortSignal can be used to cancel waiting for the event:

import { EventEmitter, once } from 'node:events';

const ee = new EventEmitter();
const ac = new AbortController();

async function foo(emitter, event, signal) {
  try {
    await once(emitter, event, { signal });
    console.log('event emitted!');
  } catch (error) {
    if (error.name === 'AbortError') {
      console.error('Waiting for the event was canceled!');
    } else {
      console.error('There was an error', error.message);
    }
  }
}

foo(ee, 'foo', ac.signal);
ac.abort(); // Abort waiting for the event
ee.emit('foo'); // Prints: Waiting for the event was canceled!

Parameters

emitter

EventEmitter

eventName

string | symbol

options?

StaticEventEmitterOptions

Returns

Promise<any[]>

Since

v11.13.0, v10.16.0

Inherited from

EventEmitter.once

Call Signature

static once(emitter, eventName, options?): Promise<any[]>

Defined in: node_modules/@types/node/events.d.ts:189

Creates a Promise that is fulfilled when the EventEmitter emits the given event or that is rejected if the EventEmitter emits 'error' while waiting. The Promise will resolve with an array of all the arguments emitted to the given event.

This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event semantics and does not listen to the 'error' event.

import { once, EventEmitter } from 'node:events';
import process from 'node:process';

const ee = new EventEmitter();

process.nextTick(() => {
  ee.emit('myevent', 42);
});

const [value] = await once(ee, 'myevent');
console.log(value);

const err = new Error('kaboom');
process.nextTick(() => {
  ee.emit('error', err);
});

try {
  await once(ee, 'myevent');
} catch (err) {
  console.error('error happened', err);
}