Class CrowdSecHTTPMiddleware

Hierarchy

CommonsMiddleware
- CrowdSecHTTPMiddleware

Index

Constructors

Properties

bouncer? logger watcher?

Methods

getLogger getMiddleware middlewareFunction start stop

Constructors

constructor

new CrowdSecHTTPMiddleware(
options: ICrowdSecHTTPMiddlewareOptions,
): CrowdSecHTTPMiddleware
Parameters
- options: ICrowdSecHTTPMiddlewareOptions
Returns CrowdSecHTTPMiddleware
Overrides CommonsMiddleware.constructor
- Defined in packages/crowdsec-http-middleware/src/CrowdSecHTTPMiddleware.ts:23

Properties

`Optional` `Readonly`bouncer

bouncer?: CrowdSecHTTPBouncerMiddleware

`Protected`logger

logger: Required<logger>

`Optional` `Readonly`watcher

watcher?: CrowdSecHTTPWatcherMiddleware

Methods

getLogger

getLogger(
    name: string,
    options?: loggerOption,
    extendedName?: string,
): Required<logger>
Parameters
- name: string
- Optionaloptions: loggerOption
- OptionalextendedName: string
Returns Required<logger>
Inherited from CommonsMiddleware.getLogger
- Defined in packages/crowdsec-http-middleware/src/CommonsMiddleware.ts:11

getMiddleware

getMiddleware(): (
req: IncomingMessage,
res?: ServerResponse<IncomingMessage>,
) => void
Returns (req: IncomingMessage, res?: ServerResponse<IncomingMessage>) => void
- Defined in packages/crowdsec-http-middleware/src/CrowdSecHTTPMiddleware.ts:109

`Protected`middlewareFunction

middlewareFunction(
req: IncomingMessage,
res?: ServerResponse<IncomingMessage>,
): void
Parameters
- req: IncomingMessage
- Optionalres: ServerResponse<IncomingMessage>
Returns void
- Defined in packages/crowdsec-http-middleware/src/CrowdSecHTTPMiddleware.ts:91

start

start(): Promise<void>
Returns Promise<void>
- Defined in packages/crowdsec-http-middleware/src/CrowdSecHTTPMiddleware.ts:53

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in packages/crowdsec-http-middleware/src/CrowdSecHTTPMiddleware.ts:114