Class WebServer

constructor

• new WebServer(options: Options): WebServer

  Parameters

  • options: Options

  Returns WebServer

host

port

server

StaticDEFAULT_CLIENT_SOCKET_TIMEOUT

close

• close(): void

  Closes the http server and all open sockets

  Returns void

doRedirect

• doRedirect(status: number, url: string, response: ServerResponse): void

  sends a response redirect.

  Parameters

  • status: number

    the statusCode for the response.

  • url: string

    the url to redirect to.

  • response: ServerResponse

    the response to write the redirect to.

  Returns void

handleError

• handleError(response: ServerResponse): Promise<void>

  Parameters

  • response: ServerResponse

  Returns Promise<void>

handlePreflightRequest

• handlePreflightRequest(response: ServerResponse): void

  Preflight request:

  https://developer.mozilla.org/en-US/docs/Glossary/Preflight_request https://www.w3.org/TR/2020/SPSD-cors-20200602/#resource-preflight-requests

  Parameters

  • response: ServerResponse

  Returns void

handleSuccess

• handleSuccess(response: ServerResponse): Promise<void>

  Parameters

  • response: ServerResponse

  Returns Promise<void>

reportError

• reportError(error: Error, response: ServerResponse): void

  sends a response to the browser reporting an error.

  Parameters

  • error: Error

    the oauth error

  • response: ServerResponse

    the HTTP response.

  Returns void

reportSuccess

• reportSuccess(response: ServerResponse): void

  sends a response to the browser reporting the success.

  Parameters

  • response: ServerResponse

    the HTTP response.

  Returns void

sendError

• sendError(status: number, message: string, response: ServerResponse): void

  sends a response error.

  Parameters

  • status: number

    the statusCode for the response.

  • message: string

    the message for the http body.

  • response: ServerResponse

    the response to write the error to.

  Returns void

setTimeoutCallback

• setTimeoutCallback(callback: () => void): void

  Sets a callback to be executed when the authentication timeout occurs

  Parameters

  • callback: () => void

  Returns void

start

• start(): Promise<void>

  Starts the http server after checking that the port is open

  Returns Promise<void>