apis
javascript api
Config

Config

zely.config.js
module.exports = require('@zely-js/zely').defineConfig({
  /* options */
});

#Server Options

  • server.port: number - Server port to use.
  • server.options: zept.ServerOptions - HTTP server options.
  • server.zept: zept.ZeptServer - Server instance.

#Zely Options


  • loaders: Loader[] - List of loaders.
  • globalImport: boolean - Whether to import methods automatically.
  • onError: Function - Callback to be called when an error is encountered.
  • enableReporter: boolean - Whether to enable the reporter for debugging. (reporter reports errors exactly through .js.map)
  • keepDist: boolean - Whether to keep the dist directory when server starts.

INFO

Type Declartion

Typescript
import { ServerOptions, ZeptServer } from '@zept/http';
import { Loader } from '@zely-js/loader';
import { Plugin, Middleware } from '@zely-js/zely';
 
export interface Config extends UserConfig {
  plugins?: Plugin[];
}
 
export interface UserConfig {
  server?: {
    port?: number;
    options?: ServerOptions;
    zept?: ZeptServer;
  };
 
  cwd?: string;
 
  middlewares?: Middleware[];
  allowAutoMiddlewares?: boolean;
  middlewareDirectory?: string;
 
  loaders?: Loader[];
 
  globalImport?: boolean;
 
  onError?: (err: Error) => void | Promise<void>;
 
  enableReporter?: boolean;
 
  keepDist?: boolean;
}