Class Https

Class representing the HTTPS server

Hierarchy

Https

Index

Constructors

Properties

errorLog requestLog server wssPaths

Methods

addWebSocketServer handleError handleRequest handleUpgrade isReady sendContent start stop

Constructors

constructor

new Https(): Https
Creates a new instance of the HTTPS server

Returns Https
- Defined in Instance/IO/Https.ts:45

Properties

`Private` errorLog

errorLog: FixedSizeArray<Error> = ...

`Private` requestLog

requestLog: FixedSizeArray<OutgoingHttpHeaders> = ...

`Private` server

server: undefined | Server<typeof IncomingMessage, typeof ServerResponse>

The HTTPS server

`Private` wssPaths

wssPaths: Map<null | string, WebSockets> = ...

Methods

addWebSocketServer

addWebSocketServer(webSockets: WebSockets, path: string): void
Adds a new WebSocket server for a specific path
Parameters
- webSockets: WebSockets
  
  The WebSockets instance to add
- path: string
  
  The path for which the WebSockets instance will be added
Returns void
- Defined in Instance/IO/Https.ts:148

`Private` handleError

handleError(error: Error): void
Handles incoming requests from listening server
Parameters
- error: Error
Returns void
- Defined in Instance/IO/Https.ts:121

`Private` handleRequest

handleRequest(request: IncomingMessage, response: ServerResponse<IncomingMessage>): void
Handles incoming requests from listening server
Parameters
- request: IncomingMessage
- response: ServerResponse<IncomingMessage>
Returns void
- Defined in Instance/IO/Https.ts:79

`Private` handleUpgrade

handleUpgrade(request: IncomingMessage, socket: Socket, head: Buffer): void
Handles incoming Wss Upgrade requests from listening server
Parameters
- request: IncomingMessage
- socket: Socket
- head: Buffer
Returns void
- Defined in Instance/IO/Https.ts:104

isReady

isReady(): Promise<boolean>
Returns a boolean indicating whether the required files for the HTTPS server are ready

Returns
True

Returns Promise<boolean>
- Defined in Instance/IO/Https.ts:156

`Private` sendContent

sendContent(response: ServerResponse<IncomingMessage>, contentType: string, contentData: string): void
Sends content in the response.
Parameters
- response: ServerResponse<IncomingMessage>
  
  The response to send the content to.
- contentType: string
  
  The type of content being sent (e.g. "text/html").
- contentData: string
  
  The data of the content being sent.
Returns void
- Defined in Instance/IO/Https.ts:131

start

start(): Promise<void>
Starts the HTTPS server

Throws
If an error occurs while starting the server

Returns Promise<void>
- Defined in Instance/IO/Https.ts:51

stop

stop(): Promise<void>
Stops the HTTPS server

Throws
If an error occurs while starting the server

Returns Promise<void>
- Defined in Instance/IO/Https.ts:70

Generated using TypeDoc