Class HttpServer

Represents an HTTP server.

Hierarchy

HttpServer

Constructors

constructor

new HttpServer(port, supportWebsocket): HttpServer
Creates a new instance of the HttpServer class.
Parameters
- port: number
  
  The port number for the server to listen on.
- supportWebsocket: boolean
  
  Determines whether to support WebSocket connections.
Returns HttpServer
- Defined in src/http/server/server.ts:29

Properties

`Private` app

app: Application

`Private` basicAuthenticationEnabled

basicAuthenticationEnabled: boolean = false

`Private` cookieName

cookieName: string = null

`Private` credentials

credentials: {
password: string;
user: string;
}[] = ...

Type declaration

password: string
user: string

`Private` indexCache

indexCache: Buffer

`Private` isServerStarted

isServerStarted: boolean = false

`Private` port

port: number

The port number for the server to listen on.

`Private` server

server: Server

`Private` serverStartedResolves

serverStartedResolves: Function[] = []

`Private` supportWebsocket

supportWebsocket: boolean

Determines whether to support WebSocket connections.

`Private` websocket

websocket: WebsocketServer

`Static` `Private` deleteMethods

deleteMethods: HttpMethod[] = ...

`Static` `Private` fileProvider

fileProvider: FileProvider[] = ...

`Static` `Private` getMethods

getMethods: HttpMethod[] = ...

`Static` `Private` imageProvider

imageProvider: ImageProvider[] = ...

`Static` `Private` postMethods

postMethods: HttpMethod[] = ...

`Static` `Private` putMethods

putMethods: HttpMethod[] = ...

Accessors

App

get App(): Application
Gets the underlying Express application instance.

Returns Application
The Express application instance.
- Defined in src/http/server/server.ts:48

Methods

addBasicCredentials

addBasicCredentials(user, password): void
Adds credentials for basic authentication.
Parameters
- user: string
  
  The username.
- password: string
  
  The password.
Returns void
- Defined in src/http/server/server.ts:281

awaitStart

awaitStart(): Promise<boolean>
Waits for the server to start listening for requests.

Returns Promise<boolean>
A promise that resolves when the server has started.
- Defined in src/http/server/server.ts:477

enableBasicAuthentication

enableBasicAuthentication(): void
Enables basic authentication for requests.

Returns void
- Defined in src/http/server/server.ts:236

enableLogging

enableLogging(): void
Enables logging for WebSocket connections.

Returns void

Deprecated
- Defined in src/http/server/server.ts:173

getCookieName

getCookieName(): string
Returns the name property for the auth cookie. This cookie is used for FileProvider/ImageProvider Authentication. Returns null if cookie authentication is disabled.

Returns string
The the name of the cookie used for authentication or null if cookies are disabled for authentication.
- Defined in src/http/server/server.ts:103

`Private` getErrorCode

getErrorCode(err): number
Parameters
- err: any
Returns number
- Defined in src/http/server/server.ts:156

getWebsocketInstance

getWebsocketInstance(): WebsocketServer
Gets the WebsocketServer instance associated with the HTTP server.

Returns WebsocketServer
The WebsocketServer instance, or null if WebSocket support is not enabled.
- Defined in src/http/server/server.ts:549

`Private` handleRequest

handleRequest(method): RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
Parameters
- method: HttpMethod
Returns RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
- Defined in src/http/server/server.ts:107

`Private` initializeFileProvider

initializeFileProvider(): void
Returns void
- Defined in src/http/server/server.ts:285

`Private` initializeHttpMethods

initializeHttpMethods(): void
Returns void
- Defined in src/http/server/server.ts:72

`Private` initializeImageProvider

initializeImageProvider(): void
Returns void
- Defined in src/http/server/server.ts:334

`Private` initializeServer

initializeServer(): void
Returns void
- Defined in src/http/server/server.ts:54

`Private` initializeWebsocket

initializeWebsocket(): void
Returns void
- Defined in src/http/server/server.ts:68

`Private` parseCookies

parseCookies(req): {
name: string;
value: string;
}[]
Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
Returns {
name: string;
value: string;
}[]
- Defined in src/http/server/server.ts:453

`Private` sendFile

sendFile(req, res, provider, id?, auth?): Promise<void>
Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
- res: Response<any, Record<string, any>>
- provider: FileProvider
- Optional id: string
- Optional auth: string
Returns Promise<void>
- Defined in src/http/server/server.ts:372

`Private` sendImage

sendImage(req, res, provider, id?, auth?): Promise<void>
Parameters
- req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
- res: Response<any, Record<string, any>>
- provider: ImageProvider
- Optional id: string
- Optional auth: string
Returns Promise<void>
- Defined in src/http/server/server.ts:421

`Private` serverStarted

serverStarted(): void
Returns void
- Defined in src/http/server/server.ts:466

setCookieName

setCookieName(name): void
Defines the name property for the auth cookie. This cookie is used for FileProvider/ImageProvider Authentication.
Parameters
- name: string
  
  the name of the cookie used for authentication.
Returns void
- Defined in src/http/server/server.ts:93

setupAngularFileServing

setupAngularFileServing(path): void
Sets up file serving for an Angular application.
Parameters
- path: string
  
  The path to the Angular application build files.
Returns void
- Defined in src/http/server/server.ts:183

setupAssetFileServing

setupAssetFileServing(path): void
Sets up file serving for static assets.
Parameters
- path: string
  
  The path to the directory containing the static assets.
Returns void
- Defined in src/http/server/server.ts:226

stop

stop(): Promise<void>
Stops the server from accepting new connections and keeps existing connections. This function is asynchronous, and the server is finally closed when all connections are ended and the server emits a 'close' event.

Returns Promise<void>
A promise that is resolved once all connections are closed.
- Defined in src/http/server/server.ts:559

`Static` registerDelete

registerDelete(config): void
Registers a DELETE method.
Parameters
- config: HttpMethod
  
  The configuration for the DELETE method.
Returns void
- Defined in src/http/server/server.ts:541

`Static` registerFileProvider

registerFileProvider(fileProvider): void
Registers a file provider.
Parameters
- fileProvider: FileProvider
  
  The file provider to register.
Returns void
- Defined in src/http/server/server.ts:491

`Static` registerGet

registerGet(config): void
Registers a GET method.
Parameters
- config: HttpMethod
  
  The configuration for the GET method.
Returns void
- Defined in src/http/server/server.ts:511

`Static` registerImageProvider

registerImageProvider(imageProvider): void
Registers an image provider.
Parameters
- imageProvider: ImageProvider
  
  The image provider to register.
Returns void
- Defined in src/http/server/server.ts:501

`Static` registerPost

registerPost(config): void
Registers a POST method.
Parameters
- config: HttpMethod
  
  The configuration for the POST method.
Returns void
- Defined in src/http/server/server.ts:521

`Static` registerPut

registerPut(config): void
Registers a PUT method.
Parameters
- config: HttpMethod
  
  The configuration for the PUT method.
Returns void
- Defined in src/http/server/server.ts:531

Class HttpServer

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

port: number

supportWebsocket: boolean

Returns HttpServer

Properties

Private app

Private basicAuthenticationEnabled

Private cookieName

Private credentials

Type declaration

password: string

user: string

Private indexCache

Private isServerStarted

Private port

Private server

Private serverStartedResolves

Private supportWebsocket

Private websocket

Static Private deleteMethods

Static Private fileProvider

Static Private getMethods

Static Private imageProvider

Static Private postMethods

Static Private putMethods

Accessors

App

Returns Application

Methods

addBasicCredentials

Parameters

user: string

password: string

Returns void

awaitStart

Returns Promise<boolean>

enableBasicAuthentication

Returns void

enableLogging

Returns void

Deprecated

getCookieName

Returns string

Private getErrorCode

Parameters

err: any

Returns number

getWebsocketInstance

Returns WebsocketServer

Private handleRequest

Parameters

method: HttpMethod

Returns RequestHandler<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

Private initializeFileProvider

Returns void

Private initializeHttpMethods

Returns void

Private initializeImageProvider

Returns void

Private initializeServer

Returns void

Private initializeWebsocket

Returns void

Private parseCookies

Parameters

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

Returns { name: string; value: string; }[]

Private sendFile

Parameters

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

res: Response<any, Record<string, any>>

`Private` app

`Private` basicAuthenticationEnabled

`Private` cookieName

`Private` credentials

`Private` indexCache

`Private` isServerStarted

`Private` port

`Private` server

`Private` serverStartedResolves

`Private` supportWebsocket

`Private` websocket

`Static` `Private` deleteMethods

`Static` `Private` fileProvider

`Static` `Private` getMethods

`Static` `Private` imageProvider

`Static` `Private` postMethods

`Static` `Private` putMethods

`Private` getErrorCode

`Private` handleRequest

`Private` initializeFileProvider

`Private` initializeHttpMethods

`Private` initializeImageProvider

`Private` initializeServer

`Private` initializeWebsocket

`Private` parseCookies

Returns {
name: string;
value: string;
}[]

`Private` sendFile

`Optional` id: string

`Optional` auth: string

`Private` sendImage

`Optional` id: string

`Optional` auth: string

`Private` serverStarted

`Static` registerDelete

`Static` registerFileProvider

`Static` registerGet

`Static` registerImageProvider

`Static` registerPost

`Static` registerPut