Options
All
  • Public
  • Public/Protected
  • All
Menu

Module routes/util

Utilities for routes.

Variables

Functions

Variables

Const errorMessageAge

errorMessageAge: number = ...

Error message maximum age.

Const formAge

formAge: number = ...

Form maximum age.

Const maxImageSize

maxImageSize: "262144" = 262144

Maximum size an image can be (in bytes).

Const upload

upload: Multer = ...

Multer uploader.

Functions

adminAuth

  • adminAuth(req: Request, res: Response, next: NextFunction): Promise<void>

  • Admin authentication middleware.

    Parameters

    • req: Request

      Request object.

    • res: Response

      Response object.

    • next: NextFunction

      Next function.

    Returns Promise<void>

auth

  • auth(req: Request, res: Response, next: NextFunction): Promise<void>

  • Authentication middleware.

    Parameters

    • req: Request

      Request object.

    • res: Response

      Response object.

    • next: NextFunction

      Next function.

    Returns Promise<void>

camelToTitle

  • camelToTitle(str: string): string

  • Convert a string from camel case to title case.

    Parameters

    • str: string

      A camel case string.

    Returns string

    The string in title case.

deleteSessionID

  • deleteSessionID(res: Response): void

  • Delete the session ID cookie.

    Parameters

    • res: Response

      Response object.

    Returns void

getDBM

  • Get the database manager.

    Parameters

    • req: Request

      Request object.

    Returns default

getErrorMessage

  • getErrorMessage(req: Request, res: Response): string | null

  • Get the error message cookie.

    Parameters

    • req: Request

      Request object.

    • res: Response

      Response object.

    Returns string | null

    The error message or a null value.

getForm

  • getForm(req: Request, res: Response): any | null

  • Get the form cookie.

    Parameters

    • req: Request

      Request object.

    • res: Response

      Response object.

    Returns any | null

    The form object or a null value.

getHostname

  • getHostname(req: Request): string

  • Get the hostname of a request.

    Parameters

    • req: Request

      Request object.

    Returns string

getSessionID

  • getSessionID(req: Request): string

  • Get the session ID cookie.

    Parameters

    • req: Request

      Request object.

    Returns string

    The session ID.

getUserID

  • getUserID(req: Request): Promise<string>

  • Get the currently logged in user's ID.

    Parameters

    • req: Request

      Request object.

    Returns Promise<string>

    The user's ID.

renderError

  • renderError(err: Error, req: Request, res: Response): Promise<void>

  • Render an error page.

    Parameters

    • err: Error

      The error.

    • req: Request

      Request object.

    • res: Response

      Response object.

    Returns Promise<void>

renderPage

  • renderPage(req: Request, res: Response, page: string, options?: any, status?: number): Promise<void>

  • Render a webpage.

    Parameters

    • req: Request

      Request object.

    • res: Response

      Response object.

    • page: string

      View to be rendered.

    • options: any = ...

      Options to be passed to the view.

    • status: number = 200

      HTTP status code.

    Returns Promise<void>

setErrorMessage

  • setErrorMessage(res: Response, message: string): void

  • Set the error message cookie.

    Parameters

    • res: Response

      Response object.

    • message: string

      Error message.

    Returns void

setForm

  • setForm(res: Response, value: any): void

  • Set the form cookie.

    Parameters

    • res: Response

      Response object.

    • value: any

      Form object.

    Returns void

setSessionID

  • setSessionID(req: Request, res: Response, sessionID: string): Promise<void>

  • Set the session ID cookie.

    Parameters

    • req: Request

      Request object.

    • res: Response

      Response object.

    • sessionID: string

      A session ID.

    Returns Promise<void>

Generated using TypeDoc