Options
All
  • Public
  • Public/Protected
  • All
Menu

Module routes/verify

Index

Functions

Functions

getRouter

  • getRouter(): express.Router

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

    Returns express.Router

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

verifyKey

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

  • Attempts to verify if the session key is valid.

    Parameters

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

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

    Returns Promise<Responses.VerifyKey>

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

Generated using TypeDoc