API Reference

API Reference

Complete reference for all available methods and configurations.

Methods

init(options)

Initialize the application with the given options.

Parameters:

Returns: Promise<App>

Example:

const app = await init({
  name: "my-app",
  debug: true
});

start(port)

Start the server on the specified port.

Parameters:

Returns: Promise<Server>

Example:

const server = await app.start(8080);
console.log("Server running on port 8080");

stop()

Gracefully stop the server.

Returns: Promise<void>

Example:

await app.stop();
console.log("Server stopped");

Events

on(event, callback)

Register an event listener.

Available Events:

• start - Fired when server starts
• stop - Fired when server stops
• error - Fired on error
• request - Fired on each request

Example:

app.on("start", () => {
  console.log("Server started!");
});
 
app.on("error", (err) => {
  console.error("Error:", err.message);
});

Configuration

Config Object

interface Config {
  // Required
  name: string;
 
  // Optional
  version?: string;
  debug?: boolean;
  port?: number;
 
  // Advanced
  middleware?: Function[];
  plugins?: Plugin[];
 
  // Logging
  logging?: {
    level: "debug" | "info" | "warn" | "error";
    format: "json" | "text";
  };
}

Environment Variables

Error Codes

For more help, check the Introduction.