steady-api/build/index.d.ts

Configurable REST API built with Express and TypeScript

/// <reference types="express" />
/// <reference types="joi" />

import { AnySchema } from 'joi';
import { RequestHandler, ErrorRequestHandler } from 'express';
import { ChildProcess } from 'child_process';
  
export class Steady {
  constructor(options: ISteadyOptions)
  attachment(name: string)
  get(url: string, handler: RequestHandler)
  post(url: string, handler: RequestHandler)
  put(url: string, handler: RequestHandler)
  delete(url: string, handler: RequestHandler)
  all(url: string, handler: RequestHandler)
}

export interface IHttpAttach {
  [key: string]: any;
}

export interface IDocsMeta {
  copyright: string;
}

export interface ISteadyOptions {
  controllersDir: string,
  routesDir: string,
  port?: number,
  apiName?: string,
  docsPath?: string,
  disableDocs?: boolean
  apiPath?: string,
  customTypes?: IParamType[],
  middleware?: (RequestHandler|ErrorRequestHandler)[],
  staticContentDir?: string
  httpAttach?: IHttpAttach,
  docsMeta?: IDocsMeta
}

export interface IParamType {
  name: string
  description: string
  validator: (param: object) => AnySchema
  example: any
}
export interface IErrorData {
  errorMessage: string
  errors: string[]
  status: number
}
export interface ISuccessData {
  [key: string]: any
}

export interface ISteadyCallback {
  (err: IErrorData, data?: ISuccessData): void
}

export interface ISteadyStreamingCallback {
  (err: IErrorData, stream?: ChildProcess, dataMapFunction?: (data: any) => any): void
}