@morojs/moro / MoroHttpServer
Class: MoroHttpServer
Defined in: src/core/http/http-server.ts:965
Constructors
Constructor
new MoroHttpServer(
options?):MoroHttpServer
Defined in: src/core/http/http-server.ts:1022
Parameters
options?
limits?
HttpRuntimeLimits
maxBodySize?
number
maxUploadSize?
number
ssl?
{ ca?: (string | Buffer<ArrayBufferLike>)[]; cert: string | Buffer<ArrayBufferLike>; key: string | Buffer<ArrayBufferLike>; minVersion?: string; passphrase?: string; rejectUnauthorized?: boolean; requestCert?: boolean; }
node-style TLS material (from the unified ssl normalizer). When present the server is created via https.createServer.
ssl.ca?
(string | Buffer<ArrayBufferLike>)[]
ssl.cert
string | Buffer<ArrayBufferLike>
ssl.key
string | Buffer<ArrayBufferLike>
ssl.minVersion?
string
ssl.passphrase?
string
ssl.rejectUnauthorized?
boolean
ssl.requestCert?
boolean
Returns
MoroHttpServer
Properties
compressionEnabled
compressionEnabled:
boolean=true
Defined in: src/core/http/http-server.ts:974
Internal
read by MoroServerResponse prototype methods
compressionThreshold
compressionThreshold:
number=1024
Defined in: src/core/http/http-server.ts:976
Internal
read by MoroServerResponse prototype methods
logger
logger:
Logger
Defined in: src/core/http/http-server.ts:980
Internal
read by MoroServerResponse prototype methods
requestTrackingEnabled
requestTrackingEnabled:
boolean=true
Defined in: src/core/http/http-server.ts:978
Internal
read by MoroIncomingMessage prototype methods
Methods
addCharsetIfNeeded()
addCharsetIfNeeded(
mimeType):string
Defined in: src/core/http/http-server.ts:1694
Internal
called by MoroServerResponse prototype methods
Parameters
mimeType
string
Returns
string
close()
close():
Promise<void>
Defined in: src/core/http/http-server.ts:2023
Returns
Promise<void>
configurePerformance()
configurePerformance(
config?):void
Defined in: src/core/http/http-server.ts:1103
Parameters
config?
compression?
{ enabled: boolean; threshold?: number; }
compression.enabled
boolean
compression.threshold?
number
minimal?
boolean
Returns
void
delete()
delete(
path, ...handlers):void
Defined in: src/core/http/http-server.ts:1199
Parameters
path
string
handlers
...(HttpHandler | Middleware)[]
Returns
void
forceCleanup()
forceCleanup():
void
Defined in: src/core/http/http-server.ts:2030
Returns
void
get()
get(
path, ...handlers):void
Defined in: src/core/http/http-server.ts:1187
Parameters
path
string
handlers
...(HttpHandler | Middleware)[]
Returns
void
getMimeType()
getMimeType(
ext):Promise<string>
Defined in: src/core/http/http-server.ts:1673
Internal
called by MoroServerResponse prototype methods
Parameters
ext
string
Returns
Promise<string>
getPerformanceStats()
getPerformanceStats():
object
Defined in: src/core/http/http-server.ts:2059
Returns
object
headerObjectPoolSize
headerObjectPoolSize:
number=poolStats.headerPool.poolSize
paramObjectPoolSize
paramObjectPoolSize:
number=poolStats.paramPool.poolSize
poolManager
poolManager:
object=poolStats
poolManager.bufferPools
bufferPools:
Record<string,any> =bufferPoolStats
poolManager.headerPool
headerPool:
object
poolManager.headerPool.acquireCount
acquireCount:
number
poolManager.headerPool.createCount
createCount:
number
poolManager.headerPool.maxSize
maxSize:
number
poolManager.headerPool.poolSize
poolSize:
number
poolManager.headerPool.releaseCount
releaseCount:
number
poolManager.headerPool.utilization
utilization:
number
poolManager.paramPool
paramPool:
object
poolManager.paramPool.acquireCount
acquireCount:
number
poolManager.paramPool.createCount
createCount:
number
poolManager.paramPool.maxSize
maxSize:
number
poolManager.paramPool.poolSize
poolSize:
number
poolManager.paramPool.releaseCount
releaseCount:
number
poolManager.paramPool.utilization
utilization:
number
poolManager.queryPool
queryPool:
object
poolManager.queryPool.acquireCount
acquireCount:
number
poolManager.queryPool.createCount
createCount:
number
poolManager.queryPool.maxSize
maxSize:
number
poolManager.queryPool.poolSize
poolSize:
number
poolManager.queryPool.releaseCount
releaseCount:
number
poolManager.queryPool.utilization
utilization:
number
poolManager.responseCache
responseCache:
object
poolManager.responseCache.hitRate
hitRate:
number
poolManager.responseCache.hits
hits:
number
poolManager.responseCache.maxSize
maxSize:
number
poolManager.responseCache.misses
misses:
number
poolManager.responseCache.size
size:
number
poolManager.routeCache
routeCache:
object
poolManager.routeCache.hitRate
hitRate:
number
poolManager.routeCache.hits
hits:
number
poolManager.routeCache.maxSize
maxSize:
number
poolManager.routeCache.misses
misses:
number
poolManager.routeCache.size
size:
number
poolManager.totalMemory
totalMemory:
object
poolManager.totalMemory.buffers
buffers:
number
poolManager.totalMemory.headers
headers:
number
poolManager.totalMemory.params
params:
number
poolManager.totalMemory.queries
queries:
number
poolManager.totalMemory.responses
responses:
number
poolManager.totalMemory.routes
routes:
number
queryObjectPoolSize
queryObjectPoolSize:
number=poolStats.queryPool.poolSize
getServer()
getServer():
Server
Defined in: src/core/http/http-server.ts:2054
Returns
Server
listen()
Call Signature
listen(
port,callback?):void
Defined in: src/core/http/http-server.ts:2004
Parameters
port
number
callback?
() => void
Returns
void
Call Signature
listen(
port,host,callback?):void
Defined in: src/core/http/http-server.ts:2005
Parameters
port
number
host
string
callback?
() => void
Returns
void
patch()
patch(
path, ...handlers):void
Defined in: src/core/http/http-server.ts:1203
Parameters
path
string
handlers
...(HttpHandler | Middleware)[]
Returns
void
post()
post(
path, ...handlers):void
Defined in: src/core/http/http-server.ts:1191
Parameters
path
string
handlers
...(HttpHandler | Middleware)[]
Returns
void
put()
put(
path, ...handlers):void
Defined in: src/core/http/http-server.ts:1195
Parameters
path
string
handlers
...(HttpHandler | Middleware)[]
Returns
void
setErrorHandler()
setErrorHandler(
fn):void
Defined in: src/core/http/http-server.ts:1129
Parameters
fn
(err, req, res) => any
Returns
void
setHookManager()
setHookManager(
hookManager):void
Defined in: src/core/http/http-server.ts:1182
Parameters
hookManager
any
Returns
void
setRequestDecorations()
setRequestDecorations(
decorations):void
Defined in: src/core/http/http-server.ts:1136
Parameters
decorations
Record<string, any>
Returns
void
setRequestTracking()
setRequestTracking(
enabled):void
Defined in: src/core/http/http-server.ts:1124
Parameters
enabled
boolean
Returns
void
setResponseDecorations()
setResponseDecorations(
decorations):void
Defined in: src/core/http/http-server.ts:1148
Parameters
decorations
Record<string, any>
Returns
void
setRouterHandler()
setRouterHandler(
fn):void
Defined in: src/core/http/http-server.ts:1098
Parameters
fn
(req, res) => boolean | Promise<boolean>
Returns
void
updateSsl()
updateSsl(
ssl):void
Defined in: src/core/http/http-server.ts:2038
Replace the TLS certificate/key for new handshakes (node's tls.Server#setSecureContext). Throws when the server is plain HTTP.
Parameters
ssl
ca?
(string | Buffer<ArrayBufferLike>)[]
cert
string | Buffer<ArrayBufferLike>
key
string | Buffer<ArrayBufferLike>
minVersion?
string
passphrase?
string
rejectUnauthorized?
boolean
requestCert?
boolean
Returns
void
use()
use(
middleware):void
Defined in: src/core/http/http-server.ts:1161
Parameters
middleware
Returns
void