Options
All
  • Public
  • Public/Protected
  • All
Menu

api-tools-ts

Index

Type aliases

DefaultMiddlewares

DefaultMiddlewares: "true" | "false"

Whether to apply default middlewares or not type

EndpointCallback

EndpointCallback: (req: Request, res: Response) => void

Type declaration

    • (req: Request, res: Response): void
    • The default callback function for an endpoint

      Parameters

      • req: Request
      • res: Response

      Returns void

HTTPMethods

HTTPMethods: "get" | "post" | "put" | "delete" | "patch"

The HTTP Methods for the AddEndPoint() method

MiddleWareCallback

MiddleWareCallback: (req: Request, res: Response, next: NextFunction) => void

Type declaration

    • (req: Request, res: Response, next: NextFunction): void
    • The Middleware callback function for creating a middleware

      Parameters

      • req: Request
      • res: Response
      • next: NextFunction

      Returns void

ParameterCallback

ParameterCallback: (req: Request, res: Response, next: NextFunction, value: number | string) => void

Type declaration

    • (req: Request, res: Response, next: NextFunction, value: number | string): void
    • The param callback function for AddParamChecker()

      Parameters

      • req: Request
      • res: Response
      • next: NextFunction
      • value: number | string

      Returns void

Generated using TypeDoc