Class Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, Excluded>

Type Parameters

Config extends Record<any, any> = {}
InternalData extends Record<any, any> = {}
ModifiedHttpContext extends AnyClass = typeof Dummy
ModifiedWsOpenContext extends AnyClass = typeof Dummy
ModifiedWsMessageContext extends AnyClass = typeof Dummy
ModifiedWsCloseContext extends AnyClass = typeof Dummy
Excluded extends (keyof Middleware)[] = []

Index

Constructors

Properties

Methods

export httpRequest httpRequestContext httpRequestFinish load wsClose wsCloseContext wsCloseFinish wsMessage wsMessageContext wsMessageFinish wsOpen wsOpenContext wsOpenFinish

Constructors

constructor

new Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, Excluded>(name, version): Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, Excluded>
Build a new Middleware
Type Parameters
- Config extends Record<any, any> = {}
- InternalData extends Record<any, any> = {}
- ModifiedHttpContext extends AnyClass = typeof Dummy
- ModifiedWsOpenContext extends AnyClass = typeof Dummy
- ModifiedWsMessageContext extends AnyClass = typeof Dummy
- ModifiedWsCloseContext extends AnyClass = typeof Dummy
- Excluded extends (keyof Middleware<{}, {}, typeof Dummy, typeof Dummy, typeof Dummy, typeof Dummy, []>)[] = []
Parameters
- name: string
- version: string
Returns Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, Excluded>
Example
```
import { Middleware } from "rjweb-server"

const middleware = new Middleware<{ greeting: string }>('Say Hi', '1.0.0')
  .httpRequest((config, server, context, ctr, end) => {
    if (ctr.url.path.includes('hello')) end(ctr.print(config.greeting))
  })
  .export()
```
Since
9.0.0
- Defined in src/classes/Middleware.ts:94

Properties

`Private` data

data: {
    callbacks: {
        httpRequest?(config, server, context, ctr, end): any;
        load?(config, server, context): any;
        wsClose?(config, server, context, ctr, end): any;
        wsMessage?(config, server, context, ctr, end): any;
        wsOpen?(config, server, context, ctr, end): any;
    };
    classContexts: {
        HttpRequest(config, Original): ModifiedHttpContext;
        WsClose(config, Original): ModifiedWsCloseContext;
        WsMessage(config, Original): ModifiedWsMessageContext;
        WsOpen(config, Original): ModifiedWsOpenContext;
    };
    finishCallbacks: {
        httpRequest?(config, server, context, ctr, ms): any;
        wsClose?(config, server, context, ctr, ms): any;
        wsMessage?(config, server, context, ctr, ms): any;
        wsOpen?(config, server, context, ctr, ms): any;
    };
} = ...

Type declaration

callbacks: {
    httpRequest?(config, server, context, ctr, end): any;
    load?(config, server, context): any;
    wsClose?(config, server, context, ctr, end): any;
    wsMessage?(config, server, context, ctr, end): any;
    wsOpen?(config, server, context, ctr, end): any;
}
- httpRequest?:function
  - httpRequest(config, server, context, ctr, end): any
  - Parameters
    - config: any
    - server: any
    - context: any
    - ctr: any
    - end: any
    Returns any
    - Defined in src/classes/Middleware.ts:36
- load?:function
  - load(config, server, context): any
  - Parameters
    - config: any
    - server: any
    - context: any
    Returns any
    - Defined in src/classes/Middleware.ts:35
- wsClose?:function
  - wsClose(config, server, context, ctr, end): any
  - Parameters
    - config: any
    - server: any
    - context: any
    - ctr: any
    - end: any
    Returns any
    - Defined in src/classes/Middleware.ts:39
- wsMessage?:function
  - wsMessage(config, server, context, ctr, end): any
  - Parameters
    - config: any
    - server: any
    - context: any
    - ctr: any
    - end: any
    Returns any
    - Defined in src/classes/Middleware.ts:38
- wsOpen?:function
  - wsOpen(config, server, context, ctr, end): any
  - Parameters
    - config: any
    - server: any
    - context: any
    - ctr: any
    - end: any
    Returns any
    - Defined in src/classes/Middleware.ts:37
classContexts: {
    HttpRequest(config, Original): ModifiedHttpContext;
    WsClose(config, Original): ModifiedWsCloseContext;
    WsMessage(config, Original): ModifiedWsMessageContext;
    WsOpen(config, Original): ModifiedWsOpenContext;
}
- HttpRequest:function
  - HttpRequest(config, Original): ModifiedHttpContext
  - Parameters
    - config: Config
    - Original: typeof HttpRequestContext
    Returns ModifiedHttpContext
    - Defined in src/classes/Middleware.ts:65
- WsClose:function
  - WsClose(config, Original): ModifiedWsCloseContext
  - Parameters
    - config: Config
    - Original: typeof WsCloseContext
    Returns ModifiedWsCloseContext
    - Defined in src/classes/Middleware.ts:68
- WsMessage:function
  - WsMessage(config, Original): ModifiedWsMessageContext
  - Parameters
    - config: Config
    - Original: typeof WsMessageContext
    Returns ModifiedWsMessageContext
    - Defined in src/classes/Middleware.ts:67
- WsOpen:function
  - WsOpen(config, Original): ModifiedWsOpenContext
  - Parameters
    - config: Config
    - Original: typeof WsOpenContext
    Returns ModifiedWsOpenContext
    - Defined in src/classes/Middleware.ts:66
finishCallbacks: {
    httpRequest?(config, server, context, ctr, ms): any;
    wsClose?(config, server, context, ctr, ms): any;
    wsMessage?(config, server, context, ctr, ms): any;
    wsOpen?(config, server, context, ctr, ms): any;
}
- httpRequest?:function
  - httpRequest(config, server, context, ctr, ms): any
  - Parameters
    - config: any
    - server: any
    - context: any
    - ctr: any
    - ms: number
    Returns any
    - Defined in src/classes/Middleware.ts:43
- wsClose?:function
  - wsClose(config, server, context, ctr, ms): any
  - Parameters
    - config: any
    - server: any
    - context: any
    - ctr: any
    - ms: number
    Returns any
    - Defined in src/classes/Middleware.ts:46
- wsMessage?:function
  - wsMessage(config, server, context, ctr, ms): any
  - Parameters
    - config: any
    - server: any
    - context: any
    - ctr: any
    - ms: number
    Returns any
    - Defined in src/classes/Middleware.ts:45
- wsOpen?:function
  - wsOpen(config, server, context, ctr, ms): any
  - Parameters
    - config: any
    - server: any
    - context: any
    - ctr: any
    - ms: number
    Returns any
    - Defined in src/classes/Middleware.ts:44

`Private` name

name: string

`Private` version

version: string

Methods

export

export(): {
use(config): UsableMiddleware<Config, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext>;
}
Export the Middleware for use in the Server

Returns {
use(config): UsableMiddleware<Config, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext>;
}
- use:function
  - use(config): UsableMiddleware<Config, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext>
  - Parameters
    - config: Config
    Returns UsableMiddleware<Config, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext>
    - Defined in src/classes/Middleware.ts:243
Since
9.0.0
- Defined in src/classes/Middleware.ts:242

httpRequest

httpRequest(callback): Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "httpRequest"]>, "httpRequest" | Excluded[number]>
Callback that runs when any HTTP Request is made
Parameters
- callback: ((config, server, context, ctr, end) => any)
  - - (config, server, context, ctr, end): any
    - Parameters
      config: Config
      server: Server<{}, [], {}>
      context: RequestContext<InternalData>
      ctr: HttpRequestContext<{}> & InstanceType<ModifiedHttpContext>
      end: EndFn
      Returns any
Returns Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "httpRequest"]>, "httpRequest" | Excluded[number]>
Since
9.0.0
- Defined in src/classes/Middleware.ts:110

httpRequestContext

httpRequestContext<NewClass>(callback): Omit<Middleware<Config, InternalData, NewClass, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "httpRequestContext"]>, "httpRequestContext" | Excluded[number]>
Modify the HttpRequestContext Class to add new properties or methods for the user
Type Parameters
- NewClass extends AnyClass
Parameters
- callback: ((config, Original) => NewClass)
  - - (config, Original): NewClass
    - Parameters
      config: Config
      Original: typeof HttpRequestContext
      Returns NewClass
Returns Omit<Middleware<Config, InternalData, NewClass, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "httpRequestContext"]>, "httpRequestContext" | Excluded[number]>
Since
9.0.0
- Defined in src/classes/Middleware.ts:132

httpRequestFinish

httpRequestFinish(callback): Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "httpRequestFinish"]>, "httpRequestFinish" | Excluded[number]>
Callback that runs when any HTTP Request finishes
Parameters
- callback: ((config, server, context, ctr, ms) => any)
  - - (config, server, context, ctr, ms): any
    - Parameters
      config: Config
      server: Server<{}, [], {}>
      context: RequestContext<InternalData>
      ctr: default<{}>
      ms: number
      Returns any
Returns Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "httpRequestFinish"]>, "httpRequestFinish" | Excluded[number]>
Since
9.0.0
- Defined in src/classes/Middleware.ts:121

load

load(callback): Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "load"]>, "load" | Excluded[number]>
Callback that runs when the middleware is loaded (server starting, can be multiple times!)
Parameters
- callback: ((config, server, context) => any)
  - - (config, server, context): any
    - Parameters
      config: Config
      server: Server<{}, [], {}>
      context: GlobalContext
      Returns any
Returns Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "load"]>, "load" | Excluded[number]>
Since
9.0.0
- Defined in src/classes/Middleware.ts:99

wsClose

wsClose(callback): Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "wsClose"]>, "wsClose" | Excluded[number]>
Callback that runs when any WebSocket Connection is closed
Parameters
- callback: ((config, server, context, ctr, end) => any)
  - - (config, server, context, ctr, end): any
    - Parameters
      config: Config
      server: Server<{}, [], {}>
      context: RequestContext<InternalData>
      ctr: WsCloseContext<{}> & InstanceType<ModifiedWsCloseContext>
      end: EndFn
      Returns any
Returns Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "wsClose"]>, "wsClose" | Excluded[number]>
Since
9.0.0
- Defined in src/classes/Middleware.ts:209

wsCloseContext

wsCloseContext<NewClass>(callback): Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, NewClass, [...Excluded[], "wsCloseContext"]>, "wsCloseContext" | Excluded[number]>
Modify the WsCloseContext Class to add new properties or methods for the user
Type Parameters
- NewClass extends AnyClass
Parameters
- callback: ((config, Original) => NewClass)
  - - (config, Original): NewClass
    - Parameters
      config: Config
      Original: typeof WsCloseContext
      Returns NewClass
Returns Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, NewClass, [...Excluded[], "wsCloseContext"]>, "wsCloseContext" | Excluded[number]>
Since
9.0.0
- Defined in src/classes/Middleware.ts:231

wsCloseFinish

wsCloseFinish(callback): Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "wsCloseFinish"]>, "wsCloseFinish" | Excluded[number]>
Callback that runs when any WebSocket Connection is closed and finishes running all events
Parameters
- callback: ((config, server, context, ctr, ms) => any)
  - - (config, server, context, ctr, ms): any
    - Parameters
      config: Config
      server: Server<{}, [], {}>
      context: RequestContext<InternalData>
      ctr: default<{}>
      ms: number
      Returns any
Returns Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "wsCloseFinish"]>, "wsCloseFinish" | Excluded[number]>
Since
9.0.0
- Defined in src/classes/Middleware.ts:220

wsMessage

wsMessage(callback): Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "wsMessage"]>, "wsMessage" | Excluded[number]>
Callback that runs when any WebSocket Message is recieved
Parameters
- callback: ((config, server, context, ctr, end) => any)
  - - (config, server, context, ctr, end): any
    - Parameters
      config: Config
      server: Server<{}, [], {}>
      context: RequestContext<InternalData>
      ctr: WsMessageContext<{}> & InstanceType<ModifiedWsMessageContext>
      end: EndFn
      Returns any
Returns Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "wsMessage"]>, "wsMessage" | Excluded[number]>
Since
9.0.0
- Defined in src/classes/Middleware.ts:176

wsMessageContext

wsMessageContext<NewClass>(callback): Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, NewClass, ModifiedWsCloseContext, [...Excluded[], "wsMessageContext"]>, "wsMessageContext" | Excluded[number]>
Modify the WsMessageContext Class to add new properties or methods for the user
Type Parameters
- NewClass extends AnyClass
Parameters
- callback: ((config, Original) => NewClass)
  - - (config, Original): NewClass
    - Parameters
      config: Config
      Original: typeof WsMessageContext
      Returns NewClass
Returns Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, NewClass, ModifiedWsCloseContext, [...Excluded[], "wsMessageContext"]>, "wsMessageContext" | Excluded[number]>
Since
9.0.0
- Defined in src/classes/Middleware.ts:198

wsMessageFinish

wsMessageFinish(callback): Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "wsMessageFinish"]>, "wsMessageFinish" | Excluded[number]>
Callback that runs when any WebSocket Message is recieved and finishes running all events
Parameters
- callback: ((config, server, context, ctr, ms) => any)
  - - (config, server, context, ctr, ms): any
    - Parameters
      config: Config
      server: Server<{}, [], {}>
      context: RequestContext<InternalData>
      ctr: default<{}>
      ms: number
      Returns any
Returns Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "wsMessageFinish"]>, "wsMessageFinish" | Excluded[number]>
Since
9.0.0
- Defined in src/classes/Middleware.ts:187

wsOpen

wsOpen(callback): Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "wsOpen"]>, "wsOpen" | Excluded[number]>
Callback that runs when any WebSocket Connection is opened
Parameters
- callback: ((config, server, context, ctr, end) => any)
  - - (config, server, context, ctr, end): any
    - Parameters
      config: Config
      server: Server<{}, [], {}>
      context: RequestContext<InternalData>
      ctr: WsOpenContext<"open", {}> & InstanceType<ModifiedWsOpenContext>
      end: EndFn
      Returns any
Returns Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "wsOpen"]>, "wsOpen" | Excluded[number]>
Since
9.0.0
- Defined in src/classes/Middleware.ts:143

wsOpenContext

wsOpenContext<NewClass>(callback): Omit<Middleware<Config, InternalData, ModifiedHttpContext, NewClass, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "wsOpenContext"]>, "wsOpenContext" | Excluded[number]>
Modify the WsOpenContext Class to add new properties or methods for the user
Type Parameters
- NewClass extends AnyClass
Parameters
- callback: ((config, Original) => NewClass)
  - - (config, Original): NewClass
    - Parameters
      config: Config
      Original: typeof WsOpenContext
      Returns NewClass
Returns Omit<Middleware<Config, InternalData, ModifiedHttpContext, NewClass, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "wsOpenContext"]>, "wsOpenContext" | Excluded[number]>
Since
9.0.0
- Defined in src/classes/Middleware.ts:165

wsOpenFinish

wsOpenFinish(callback): Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "wsOpenFinish"]>, "wsOpenFinish" | Excluded[number]>
Callback that runs when any WebSocket Connection is opened and finishes running all events
Parameters
- callback: ((config, server, context, ctr, ms) => any)
  - - (config, server, context, ctr, ms): any
    - Parameters
      config: Config
      server: Server<{}, [], {}>
      context: RequestContext<InternalData>
      ctr: default<{}>
      ms: number
      Returns any
Returns Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "wsOpenFinish"]>, "wsOpenFinish" | Excluded[number]>
Since
9.0.0
- Defined in src/classes/Middleware.ts:154

Class Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, Excluded>

Type Parameters

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, Excluded>

Example

Since

Properties

Private data

Type declaration

callbacks: { httpRequest?(config, server, context, ctr, end): any; load?(config, server, context): any; wsClose?(config, server, context, ctr, end): any; wsMessage?(config, server, context, ctr, end): any; wsOpen?(config, server, context, ctr, end): any; }

httpRequest?:function

Parameters

Returns any

load?:function

Parameters

Returns any

wsClose?:function

Parameters

Returns any

wsMessage?:function

Parameters

Returns any

wsOpen?:function

Parameters

Returns any

classContexts: { HttpRequest(config, Original): ModifiedHttpContext; WsClose(config, Original): ModifiedWsCloseContext; WsMessage(config, Original): ModifiedWsMessageContext; WsOpen(config, Original): ModifiedWsOpenContext; }

HttpRequest:function

Parameters

Returns ModifiedHttpContext

WsClose:function

Parameters

Returns ModifiedWsCloseContext

WsMessage:function

Parameters

Returns ModifiedWsMessageContext

WsOpen:function

Parameters

Returns ModifiedWsOpenContext

finishCallbacks: { httpRequest?(config, server, context, ctr, ms): any; wsClose?(config, server, context, ctr, ms): any; wsMessage?(config, server, context, ctr, ms): any; wsOpen?(config, server, context, ctr, ms): any; }

httpRequest?:function

Parameters

Returns any

wsClose?:function

Parameters

Returns any

wsMessage?:function

Parameters

Returns any

wsOpen?:function

Parameters

Returns any

Private name

Private version

Methods

export

Returns { use(config): UsableMiddleware<Config, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext>; }

use:function

Parameters

Returns UsableMiddleware<Config, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext>

Since

httpRequest

Parameters

Parameters

Returns any

Returns Omit<Middleware<Config, InternalData, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "httpRequest"]>, "httpRequest" | Excluded[number]>

Since

httpRequestContext

Type Parameters

Parameters

Parameters

Returns NewClass

Returns Omit<Middleware<Config, InternalData, NewClass, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext, [...Excluded[], "httpRequestContext"]>, "httpRequestContext" | Excluded[number]>

Since

`Private` data

callbacks: {
httpRequest?(config, server, context, ctr, end): any;
load?(config, server, context): any;
wsClose?(config, server, context, ctr, end): any;
wsMessage?(config, server, context, ctr, end): any;
wsOpen?(config, server, context, ctr, end): any;
}

classContexts: {
HttpRequest(config, Original): ModifiedHttpContext;
WsClose(config, Original): ModifiedWsCloseContext;
WsMessage(config, Original): ModifiedWsMessageContext;
WsOpen(config, Original): ModifiedWsOpenContext;
}

finishCallbacks: {
httpRequest?(config, server, context, ctr, ms): any;
wsClose?(config, server, context, ctr, ms): any;
wsMessage?(config, server, context, ctr, ms): any;
wsOpen?(config, server, context, ctr, ms): any;
}

`Private` name

`Private` version

Returns {
use(config): UsableMiddleware<Config, ModifiedHttpContext, ModifiedWsOpenContext, ModifiedWsMessageContext, ModifiedWsCloseContext>;
}