API Reference

Complete API documentation for HyperDynamic.

Core API

The main class for creating an application instance.


import { HyperDynamic } from 'hyperdynamic'
 
const app = new HyperDynamic(options)

Option	Type	Default	Description
`name`	`string`	`'app'`	Application name
`port`	`number`	`3000`	Server port
`debug`	`boolean`	`false`	Enable debug mode

Starts the application server.


await app.start()
// Server is now running

Stops the application server.


await app.stop()
// Server has been shut down

Creates a logger instance.


import { createLogger } from 'hyperdynamic'
 
const logger = createLogger('my-module')
logger.info('Hello, world!')