Options
All
  • Public
  • Public/Protected
  • All
Menu

Module routes/coach

Index

Functions

Functions

deleteCoach

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

  • Attempts to delete a coach 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 /coaches/ related endpoints.

    Returns express.Router

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

listCoaches

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

  • Attempts to list all coaches 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.CoachList>

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

modCoach

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

  • Attempts to modify a certain coach 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.PartialCoach>

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

Generated using TypeDoc