Class App

Application class.

Constructors

constructor

new App(options?: AppOptions): App
Parameters
- options: AppOptions = {}
Returns App
- Defined in mojo.js-main/src/app.ts:201

Properties

_contextClass

_contextClass: any = ...

_nestedHelpers

_nestedHelpers: Record<string, NestedHelpers> = {}

cli

cli: CLI = ...

Command line interface.

Example

// Add another path to load commands from
app.cli.commandPaths.push(app.home.child('cli').toString());

config

config: Record<string, any>

Application config.

Example

// Remove value
delete app.config.foo;

// Assign multiple values at once
Object.assign(app.config, {foo: 'test', bar: 23});

defaults

defaults: Record<string, any> = {}

Default stash values.

Example

// Remove value
delete app.defaults.foo;

// Assign multiple values at once
Object.assign(app.defaults, {foo: 'test', bar: 23});

detectImport

detectImport: boolean

Detect if the application has been imported and disable the command line interface if it has.

exceptionFormat

exceptionFormat: string

Format for HTTP exceptions ("html", "json", or "txt").

Example

// Change default exception format for whole application
app.exceptionFormat = 'json';

home

home: Path = ...

Application home directory.

Example

// Portably generate path relative to home directory
const path = app.home.child('data', 'important.txt');

hooks

hooks: Hooks = ...

Application hooks.

Example

// Run a custom hook
await app.hooks.runHook('my:hook', foo, bar);

log

log: Logger

Application logger.

Example

// Log debug message
app.log.debug('It works');

maxRequestSize

maxRequestSize: number = ...

Maximum request body size in bytes, defaults to 16777216 (16 MiB). Requests exceeding the limit are answered with 413 when the body is read. Can also be changed for individual requests with ctx.req.maxMessageSize.

Example

// Allow larger uploads for the whole application
app.maxRequestSize = 1024 * 1024 * 1024;

mime

mime: Mime = ...

MIME types.

Example

// Get MIME type for extension
const type = app.mime.extType('txt');

mode

mode: string

Operating mode for application. Defaults to the value of the NODE_ENV environment variable or development.

models

models: MojoModels = ...

Storage for user defined models.

Example

// Store database connection
app.models.pg = new Pg('postgres://127.0.0.1:5432/db');

renderer

renderer: Renderer = ...

Application renderer.

Example

// Disable compression
app.renderer.autoCompress = false;

// Add another "views" directory
app.renderer.viewPaths.push(app.home.child('views').toString());

router

router: Router = ...

Application router.

Example

// Add routes
const r = app.router;
r.get('/foo/bar').to('test#foo', {title: 'Hello Mojo!'});
r.post('/baz').to('test#baz');

// Add another path to load controllers from
app.router.controllerPaths.push(app.home.child('more-controllers').toString());

secrets

secrets: string[]

Rotating secret passphrases used for signed cookies and the like.

Example

// Rotate passphrases
app.secrets = ['new_passw0rd', 'old_passw0rd', 'very_old_passw0rd'];

session

session: Session = ...

Encrypted cookie based session manager.

Example

// Change name of cookie used for all sessions
app.sessions.cookieName = 'mysession';

// Disable SameSite feature
app.sessions.sameSite = 'none';

static

static: Static = ...

Static file server.

Example

// Add another "public" directory
app.static.publicPaths.push('/home/sri/public');

// Add another "public" directory with higher precedence
app.static.publicPaths.unshift('/home/sri/themes/blue/public');

ua

ua: UserAgent = ...

HTTP/WebSocket user-agent.

Example

# Perform HTTP request
const res = await app.ua.get('http://example.com');

validator

validator: Validator = ...

JSON schema validator.

Example

// Add a named schema for later use
app.validator.addSchema({type: 'object', properties: {test: {type: 'number'}}}, 'testForm');

Methods

addAppHook

addAppHook(name: string, fn: AppHook): this
Add an application hook to extend the framework.
Parameters
- name: string
- fn: AppHook
Returns this
Example
```
// Run code whenever a server has been started
app.addAppHook('server:start', async app => {
  ...
});
```
- Defined in mojo.js-main/src/app.ts:225

addContextHook

addContextHook(name: string, fn: ContextHook): this
Add a context hook to extend the framework.
Parameters
- name: string
- fn: ContextHook
Returns this
Example
```
// Run code after a new request has been received
app.addContextHook('dispatch:before', async ctx => {
  ...
});
```
- Defined in mojo.js-main/src/app.ts:238

addHelper

addHelper(name: string, fn: MojoAction): this

Add a helper.

Parameters

name: string
fn: MojoAction

Returns this

Example

// Render response with header
app.addHelper('renderWithHeader', async (ctx, ...args) => {
  ctx.res.set('X-Mojo', 'I <3 mojo.js!');
  await ctx.render(...args);
});

// Render response with header using nested helper
app.addHelper('renderWith.header', async (ctx, ...args) => {
  ctx.res.set('X-Mojo', 'I <3 mojo.js!');
  await ctx.render(...args);
});

any

any(...args: AnyArguments): Route

Generate route matching any of the listed HTTP request methods or all.

Parameters

...args: AnyArguments

Returns Route

Example

// Route with pattern and destination
app.any('/user').to('User#whatever');

// Route with HTTP methods, pattern, restrictive placeholders and destination
app.any(['DELETE', 'PUT'], '/:foo', {foo: /\w+/}).to('Foo#bar');

// Route with pattern, name and destination
app.any('/:foo').name('foo_route').to('Foo#bar');

// Route with pattern, condition and destination
app.any('/').requires({agent: /Firefox/}).to('Foo#bar');

// Route with pattern and a closure as destination
app.any('/:foo', async ctx => ctx.render({text: 'Hello World!'}));

decorateContext

decorateContext(name: string, fn: Decoration): this
Decorate context class with a method or getter/setter.
Parameters
- name: string
- fn: Decoration
Returns this
Example
```
// Decorate context with getter
app.decorateContext('helloWorld', {get: () => 'Hello World!'});
```
- Defined in mojo.js-main/src/app.ts:321

delete

delete(...args: RouteArguments): Route
Generate route matching only DELETE requests.
Parameters
- ...args: RouteArguments
Returns Route
Example
```
// Route with destination
app.delete('/user').to('User#remove');
```
- Defined in mojo.js-main/src/app.ts:342

get

get(...args: RouteArguments): Route
Generate route matching only GET requests.
Parameters
- ...args: RouteArguments
Returns Route
Example
```
// Route with destination
app.get('/user').to('User#show');
```
- Defined in mojo.js-main/src/app.ts:352

handleRequest

handleRequest(ctx: MojoContext): Promise<void>
Handle a new incoming request, used by servers.
Parameters
- ctx: MojoContext
Returns Promise<void>
- Defined in mojo.js-main/src/app.ts:359

newContext

newContext(
    req: ServerRequest,
    res: ServerResponse,
    backend: BackendInfo,
): MojoContext
Create a context for application.
Parameters
- req: ServerRequest
- res: ServerResponse
- backend: BackendInfo
Returns MojoContext
- Defined in mojo.js-main/src/app.ts:372

newMockContext

newMockContext(
options?: { headers?: string[]; method?: string; url?: string },
): MojoContext
Create a mock context for application. Very useful for testing helpers.
Parameters
- options: { headers?: string[]; method?: string; url?: string } = {}
Returns MojoContext
Example
```
// Use a mock context to call a helper
const ctx = app.newMockContext();
const html = ctx.assetTag('/app.js');
```
- Defined in mojo.js-main/src/app.ts:385

newMockUserAgent

newMockUserAgent(
options?: UserAgentOptions,
serverOptions?: ServerOptions,
): Promise<MockUserAgent>
Create a new mock user-agent for application.
Parameters
- Optionaloptions: UserAgentOptions
- OptionalserverOptions: ServerOptions
Returns Promise<MockUserAgent>
- Defined in mojo.js-main/src/app.ts:408

newTestUserAgent

newTestUserAgent(
options?: TestUserAgentOptions,
serverOptions?: ServerOptions,
): Promise<TestUserAgent>
Create a new test user-agent for application.
Parameters
- Optionaloptions: TestUserAgentOptions
- OptionalserverOptions: ServerOptions
Returns Promise<TestUserAgent>
Example
```
// Test plain text endpoint
const ua = await app.newTestUserAgent();
(await ua.getOk('/')).statusIs(200).bodyIs('Hello World!');
```
- Defined in mojo.js-main/src/app.ts:419

onStart

onStart(fn: AppHook): this
Your main hook into the application, it is a shortcut for the app:start hook and runs during application startup. You can use it to perform tasks like preparing database connections.
Parameters
- fn: AppHook
Returns this
Example
```
// Perform async operations on application startup
app.onStart(async app => {
  if (app.models.db === undefined) app.models.db = new SomeDatabase();
  await app.models.db.connect();
});
```
- Defined in mojo.js-main/src/app.ts:433

onStop

onStop(fn: AppHook): this
The opposite of onStart, it is a shortcut for the app:stop hook and runs during application shutdown. You can use it to perform tasks like closing database connections gracefully.
Parameters
- fn: AppHook
Returns this
Example
```
app.onStop(async app => {
  await app.models.db.disconnect();
});
```
- Defined in mojo.js-main/src/app.ts:445

options

options(...args: RouteArguments): Route
Generate route matching only OPTIONS requests.
Parameters
- ...args: RouteArguments
Returns Route
Example
```
// Route with destination
app.options('/user').to('User#overview');
```
- Defined in mojo.js-main/src/app.ts:455

patch

patch(...args: RouteArguments): Route
Generate route matching only PATCH requests.
Parameters
- ...args: RouteArguments
Returns Route
Example
```
// Route with destination
app.patch('/user').to('User#update');
```
- Defined in mojo.js-main/src/app.ts:465

plugin

plugin<T>(
plugin: (app: App, options: Record<string, any>) => T,
options?: Record<string, any>,
): T
Register plugin.
Type Parameters
- T
Parameters
- plugin: (app: App, options: Record<string, any>) => T
- options: Record<string, any> = {}
Returns T
Example
```
// Mount application under "/prefix"
app.plugin(mountPlugin, {app: myOtherApp, path: '/prefix'});

// Load configuration from file
app.plugin(jsonConfigPlugin, {file: 'myapp.conf'});
```
- Defined in mojo.js-main/src/app.ts:478

post

post(...args: RouteArguments): Route
Generate route matching only POST requests.
Parameters
- ...args: RouteArguments
Returns Route
Example
```
// Route with destination
app.post('/user').to('User#create');
```
- Defined in mojo.js-main/src/app.ts:488

put

put(...args: RouteArguments): Route
Generate route matching only PUT requests.
Parameters
- ...args: RouteArguments
Returns Route
Example
```
// Route with destination
app.put('/user').to('User#replace');
```
- Defined in mojo.js-main/src/app.ts:498

query

query(...args: RouteArguments): Route
Generate route matching only QUERY requests.
Parameters
- ...args: RouteArguments
Returns Route
Example
```
// Route with destination
app.query('/search').to('Search#index');
```
- Defined in mojo.js-main/src/app.ts:508

start

start(command?: string, ...args: string[]): Promise<void>
Start the command line interface.
Parameters
- Optionalcommand: string
- ...args: string[]
Returns Promise<void>
Example
```
// Get arguments from "process.argv"
app.start();

// Always start server (rarely used)
app.start('server', '-l', 'http://*:8080');
```
- Defined in mojo.js-main/src/app.ts:521

under

under(...args: AnyArguments): Route

Generate route for a nested route with its own intermediate destination.

Parameters

...args: AnyArguments

Returns Route

Example

// Intermediate destination and prefix shared between two routes
const auth = app.under('/user').to('User#auth');
auth.get('/show').to('User#show');
auth.post('/create').to('User#create');

warmup

warmup(): Promise<void>
Warmup the cache, usually called automatically.

Returns Promise<void>
- Defined in mojo.js-main/src/app.ts:544

websocket

websocket(...args: RouteArguments): Route
Generate route matching only WebSocket handshake requests.
Parameters
- ...args: RouteArguments
Returns Route
Example
```
// Route with destination
app.websocket('/echo').to('Example#echo');
```
- Defined in mojo.js-main/src/app.ts:555

Class App

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns App

Properties

_contextClass

_nestedHelpers

cli

Example

config

Example

defaults

Example

detectImport

exceptionFormat

Example

home

Example

hooks

Example

log

Example

maxRequestSize

Example

mime

Example

mode

models

Example

renderer

Example

router

Example

secrets

Example

session

Example

static

Example

ua

Example

validator

Example

Methods

addAppHook

Parameters

Returns this

Example

addContextHook

Parameters

Returns this

Example

addHelper

Parameters

Returns this

Example

any

Parameters

Returns Route

Example

decorateContext

Parameters

Returns this

Example

delete

Parameters

Returns Route

Example

get

Parameters

Returns Route

Example

handleRequest

Parameters

Returns Promise<void>