Options
All
  • Public
  • Public/Protected
  • All
Menu

Module routes/admin

Index

Functions

Functions

deleteAdmin

  • deleteAdmin(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>): Promise<Responses.Empty>

  • Attempts to delete an admin from the system.

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

      The Express.js request to extract all required data from.

    Returns Promise<Responses.Empty>

    See the API documentation. Successes are passed using Promise.resolve, failures using Promise.reject.

getRouter

  • getRouter(): express.Router

  • Gets the router for all /admin/ related endpoints.

    Returns express.Router

    An Express.js {@link express.Router} routing all /admin/ endpoints.

listAdmins

  • listAdmins(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>): Promise<Responses.AdminList>

  • Attempts to list all admins in the system.

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

      The Express.js request to extract all required data from.

    Returns Promise<Responses.AdminList>

    See the API documentation. Successes are passed using Promise.resolve, failures using Promise.reject.

modAdmin

  • modAdmin(req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>): Promise<Responses.Admin>

  • Attempts to update a certain admin in the system.

    Parameters

    • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

      The Express.js request to extract all required data from.

    Returns Promise<Responses.Admin>

    See the API documentation. Successes are passed using Promise.resolve, failures using Promise.reject.

Generated using TypeDoc