Class Server<Options, Middlewares, Context>

Type Parameters

const Options extends ServerOptions
Middlewares extends UsableMiddleware[] = []
Context extends Record<string, any> = {}

Index

Constructors

constructor

new Server<const Options, Middlewares, Context>(implementation, options, middlewares?, context?): Server<Options, Middlewares, Context>
Construct a new Server Instance
Type Parameters
- const Options extends ServerOptions
- Middlewares extends UsableMiddleware[] = []
- Context extends Record<string, any> = {}
Parameters
- implementation: BaseImplementation
- options: Options
- Optional middlewares: Middlewares
- context: Context = ...
Returns Server<Options, Middlewares, Context>
Example
```
import { Server } from "rjweb-server"
import { Runtime } from "@rjweb/runtime-bun"

const server = new Server(Runtime, {
  port: 3000
})
```
Since
3.0.0
- Defined in src/classes/Server.ts:91

Properties

Validator

Validator: (new <Data>(...args) => default<Data, Context, Middlewares>) = Validator

Type declaration

- new <Data>(...args): default<Data, Context, Middlewares>
- Type Parameters
  - Data extends Record<string, any>
  Parameters
  - Rest ...args: []
  Returns default<Data, Context, Middlewares>

`Private` _status

_status: ServerStatus = 'stopped'

`Private` context

context: Context = ...

`Private` global

global: GlobalContext

`Private` implementation

implementation: Implementation

`Private` interval

interval: null | Timeout = null

`Private` middlewares

middlewares: Middlewares

`Private` openAPISchemas

openAPISchemas: Record<string, SchemaObject | ReferenceObject> = {}

`Private` options

options: {
    bind: string;
    compression: {
        http: {
            enabled: boolean;
            maxSize: number;
            minSize: number;
            preferOrder: CompressionAlgorithm[];
        };
        ws: {
            enabled: boolean;
            maxSize: number;
        };
    };
    logging: {
        debug: boolean;
        error: boolean;
        warn: boolean;
    };
    methods: {
        head: boolean;
        trace: boolean;
    };
    performance: {
        eTag: boolean;
        lastModified: boolean;
    };
    port: number;
    proxy: {
        compress: boolean;
        credentials: {
            authenticate: boolean;
            password: string;
            username: string;
        };
        enabled: boolean;
        force: boolean;
        header: Lowercase<string>;
        ips: {
            list: (Subnet<4 | 6> | IPAddress<4 | 6>)[];
            mode: "whitelist" | "blacklist";
            validate: boolean;
        };
    };
    version: boolean;
}

Type declaration

bind: string
THe IP Address to bind the server to
Default
```
"0.0.0.0"
```
Since
0.0.4
compression: {
    http: {
        enabled: boolean;
        maxSize: number;
        minSize: number;
        preferOrder: CompressionAlgorithm[];
    };
    ws: {
        enabled: boolean;
        maxSize: number;
    };
}
Various Compression-Related Settings

Since
9.0.0
- http: {
      enabled: boolean;
      maxSize: number;
      minSize: number;
      preferOrder: CompressionAlgorithm[];
  }
  HTTP Compression Settings
  
  Since
  9.0.0
  - enabled: boolean
    Whether HTTP Compression is enabled
    Default
```
true
```
    Since
    9.0.0
  - maxSize: number
    The Maximum Size of an Item allowed to be compressed
    Default
```
size(10).mb()
```
    Since
    9.0.0
  - minSize: number
    The Minimum Size of an Item allowed to be compressed
    Default
```
size(1).kb()
```
  - preferOrder: CompressionAlgorithm[]
    The Order in which to prefer Compression Algorithms, non included wont be used
    Default
```
["brotli", "gzip", "deflate"]
```
    Since
    9.0.0
- ws: {
  enabled: boolean;
  maxSize: number;
  }
  WebSocket Compression Settings
  
  Since
  9.0.0
  - enabled: boolean
    Whether WebSocket Compression is enabled
    Default
```
true
```
    Since
    9.0.0
  - maxSize: number
    The Maximum Size of an Item allowed to be compressed
    Default
```
size(1).mb()
```
    Since
    9.0.0
logging: {
    debug: boolean;
    error: boolean;
    warn: boolean;
}
Various Logging-Related Settings

Since
7.4.0
- debug: boolean
  Whether to enable DEBUG Logs
  Default
```
false
```
  Since
  7.4.0
- error: boolean
  Whether to enable ERROR Logs
  Default
```
true
```
  Since
  7.4.0
- warn: boolean
  Whether to enable WARN Logs
  Default
```
true
```
  Since
  7.4.0
methods: {
head: boolean;
trace: boolean;
}
The HTTP Methods that should automatically be handled for you

Since
9.5.0
- head: boolean
  Whether to automatically handle HEAD Requests
  Default
```
true
```
  Since
  9.5.0
- trace: boolean
  Whether to automatically handle TRACE Requests
  Default
```
false
```
  Since
  9.5.0
performance: {
eTag: boolean;
lastModified: boolean;
}
Various Performance-Related Settings

Since
6.3.0
- eTag: boolean
  Whether to include ETag Headers on every request with a direct Body
  Default
```
true
```
  Since
  6.3.0
- lastModified: boolean
  Whether to include Last-Modified Headers on every request that serves a file
  Default
```
true
```
  Since
  6.3.0
port: number
The Port to use for the Server, can be random using 0
Default
```
0
```
Since
0.0.1
proxy: {
    compress: boolean;
    credentials: {
        authenticate: boolean;
        password: string;
        username: string;
    };
    enabled: boolean;
    force: boolean;
    header: Lowercase<string>;
    ips: {
        list: (Subnet<4 | 6> | IPAddress<4 | 6>)[];
        mode: "whitelist" | "blacklist";
        validate: boolean;
    };
}
HTTP Proxy Options

Since
8.0.0
- compress: boolean
  Whether to compress the requests
  Default
```
false
```
  Since
  9.0.0
- credentials: {
      authenticate: boolean;
      password: string;
      username: string;
  }
  The Credentials that the proxy will use
  
  Since
  8.0.0
  - authenticate: boolean
    Whether to authenticate proxy requests
    Default
```
false
```
    Since
    8.0.0
  - password: string
    The Password required to authenticate
    Default
```
"proxy"
```
    Since
    8.0.0
  - username: string
    The Username required to authenticate
    Default
```
"proxy"
```
    Since
    8.0.0
- enabled: boolean
  Whether to check for proxies and use alternate IPs
  Default
```
false
```
  Since
  8.0.0
- force: boolean
  Whether to force all requests through the proxy
  Default
```
false
```
  Since
  8.0.0
- header: Lowercase<string>
  The Header to use for getting the actual IP address, it must only include the IP address
  Default
```
"x-forwarded-for"
```
  Since
  8.0.0
- ips: {
      list: (Subnet<4 | 6> | IPAddress<4 | 6>)[];
      mode: "whitelist" | "blacklist";
      validate: boolean;
  }
  The IPs the server will validate against
  
  Since
  9.0.0
  - list: (Subnet<4 | 6> | IPAddress<4 | 6>)[]
    The List of Authorized (or Unauthorized) Proxy IPs
    Default
```
[...ReverseProxyIps.LOCAL, ...ReverseProxyIps.CLOUDFLARE]
```
    Since
    9.0.0
  - mode: "whitelist" | "blacklist"
    The Mode in which to validate the list
    Default
```
"whitelist"
```
    Since
    9.0.0
  - validate: boolean
    Whether to validate proxy ips
    Default
```
false
```
    Since
    9.0.0
version: boolean
Whether to add the rjweb-server header that contains the version
Default
```
true
```
Since
9.0.0

`Private` promises

promises: Promise<any>[] = []

Accessors

FileLoader

get FileLoader(): (new (prefix) => default<Middlewares, [], Context, []>)
Returns (new (prefix) => default<Middlewares, [], Context, []>)
- - new (prefix): default<Middlewares, [], Context, []>
  - Parameters
    - prefix: string
    Returns default<Middlewares, [], Context, []>
- Defined in src/classes/Server.ts:190

Methods

$channel

$channel<C>(channel): Channel<C>
Grab a Channel from either a string identifier or a Channel object
Type Parameters
- C extends Content = any
Parameters
- channel: string | Channel<C>
Returns Channel<C>
Example
```
const channel = ctr.$channel('channel')

await channel.send('text', 'Ok')

// or

const ref = new Channel<string>()
const channel = ctr.$channel(ref)

await channel.send('text', 'Ok')
```
Since
9.8.1
- Defined in src/classes/Server.ts:138

contentTypes

contentTypes(callback): this
Add a Content Type Mapping to override (or expand) content types
Parameters
- callback: ((builder) => default)
  - - (builder): default
    - Parameters
      builder: default
      Returns default
Returns this
Since
5.3.0
- Defined in src/classes/Server.ts:179

error

error<Key>(key, callback): this
Listen to Error Callbacks
Type Parameters
- Key extends keyof ErrorCallbacks<Middlewares, Context>
Parameters
- key: Key
- callback: ErrorCallbacks<Middlewares, Context>[Key]
Returns this
Since
9.0.0
- Defined in src/classes/Server.ts:205

fetch

fetch(path, request?): Promise<Response>
Fetch (simulate) a request to the Server
Parameters
- path: string | URL
- Optional request: RequestInit
Returns Promise<Response>
Since
9.3.0
- Defined in src/classes/Server.ts:154

finish

finish<Key>(key, callback): this
Listen to Handler Finish Callbacks
Type Parameters
- Key extends keyof FinishCallbacks<Middlewares, Context>
Parameters
- key: Key
- callback: FinishCallbacks<Middlewares, Context>[Key]
Returns this
Since
9.5.5
- Defined in src/classes/Server.ts:223

http

http(callback): this
Listen to all HTTP Requests (does not override routed ones)
Parameters
- callback: ((ctr, end) => any)
  - - (ctr, end): any
    - Parameters
      ctr: DataContext<"HttpRequest", "GET", HttpRequestContext<Context>, Middlewares>
      end: EndFn
      Returns any
Returns this
Since
9.0.0
- Defined in src/classes/Server.ts:255

notFound

notFound(callback): this
Listen to Not Found Callbacks
Parameters
- callback: ((ctr) => any)
  - - (ctr): any
    - Parameters
      ctr: DataContext<"HttpRequest", "GET", HttpRequestContext<Context>, Middlewares>
      Returns any
Returns this
Since
9.0.0
- Defined in src/classes/Server.ts:232

openAPI

openAPI(name, version, server, contact?): OpenAPIObject
Generate an OpenAPI Specification for the Server
Parameters
- name: string
- version: string
- server: ServerObject
- Optional contact: ContactObject
Returns OpenAPIObject
Since
9.0.0
- Defined in src/classes/Server.ts:264

path

path(prefix, callback): this
Create a new Path
Parameters
- prefix: string
- callback: ((path) => any)
  - - (path): any
    - Parameters
      path: default<Middlewares, [], Context, []>
      Returns any
Returns this
Since
6.0.0
- Defined in src/classes/Server.ts:241

port

port(): null | (Options extends {
        port: number;
    }
    ? Options<Options>["port"] extends 0
        ? number
        : Options<Options>["port"]
    : number)
Get the Server's Port that its listening on

Returns null | (Options extends {
        port: number;
    }
    ? Options<Options>["port"] extends 0
        ? number
        : Options<Options>["port"]
    : number)
Since
9.0.0
- Defined in src/classes/Server.ts:327

rateLimit

rateLimit<Key>(key, callback): this
Listen to Ratelimit Callbacks
Type Parameters
- Key extends keyof RatelimitCallbacks<Middlewares, Context>
Parameters
- key: Key
- callback: RatelimitCallbacks<Middlewares, Context>[Key]
Returns this
Since
9.0.0
- Defined in src/classes/Server.ts:214

schema

schema(name, schema): this
Add an OpenAPI Schema to the Server
Parameters
- name: string
- schema: SchemaObject | ReferenceObject
Returns this
Since
9.0.0
- Defined in src/classes/Server.ts:318

start

start(): Promise<number>

Start the Server Instance

Returns Promise<number>

Example

import { Server } from "rjweb-server"

const server = new Server({})

server.start().then((port) => {
  console.log(`Server Started on Port ${port}`)
})

Since

3.0.0

status

status(): ServerStatus
Get the Server's Status

Returns ServerStatus
Since
9.0.0
- Defined in src/classes/Server.ts:336

stop

stop(): this

Stop the Server Instance

Returns this

Example

import { Server } from "rjweb-server"

const server = new Server(...)

server.start().then((port) => {
  console.log(`Server Started on Port ${port}`)

  setTimeout(() => {
    server.stop()
    console.log('Server Stopped after 5 seconds')
  }, 5000)
})

Since

3.0.0

Class Server<Options, Middlewares, Context>

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Server<Options, Middlewares, Context>

Example

Since

Properties

Validator

Type declaration

Type Parameters

Parameters

Returns default<Data, Context, Middlewares>

Private _status

Private context

Private global

Private implementation

Private interval

Private middlewares

Private openAPISchemas

Private options

Type declaration

bind: string

Default

Since

compression: { http: { enabled: boolean; maxSize: number; minSize: number; preferOrder: CompressionAlgorithm[]; }; ws: { enabled: boolean; maxSize: number; }; }

Since

http: { enabled: boolean; maxSize: number; minSize: number; preferOrder: CompressionAlgorithm[]; }

Since

enabled: boolean

Default

Since

maxSize: number

Default

Since

minSize: number

Default

preferOrder: CompressionAlgorithm[]

Default

Since

ws: { enabled: boolean; maxSize: number; }

Since

enabled: boolean

Default

Since

maxSize: number

Default

Since

logging: { debug: boolean; error: boolean; warn: boolean; }

Since

debug: boolean

Default

Since

error: boolean

Default

Since

warn: boolean

Default

Since

methods: { head: boolean; trace: boolean; }

Since

head: boolean

Default

Since

trace: boolean

Default

Since

performance: { eTag: boolean; lastModified: boolean; }

Since

eTag: boolean

Default

Since

lastModified: boolean

`Private` _status

`Private` context

`Private` global

`Private` implementation

`Private` interval

`Private` middlewares

`Private` openAPISchemas

`Private` options

compression: {
http: {
enabled: boolean;
maxSize: number;
minSize: number;
preferOrder: CompressionAlgorithm[];
};
ws: {
enabled: boolean;
maxSize: number;
};
}

http: {
enabled: boolean;
maxSize: number;
minSize: number;
preferOrder: CompressionAlgorithm[];
}

ws: {
enabled: boolean;
maxSize: number;
}

logging: {
debug: boolean;
error: boolean;
warn: boolean;
}

methods: {
head: boolean;
trace: boolean;
}

performance: {
eTag: boolean;
lastModified: boolean;
}

proxy: {
compress: boolean;
credentials: {
authenticate: boolean;
password: string;
username: string;
};
enabled: boolean;
force: boolean;
header: Lowercase<string>;
ips: {
list: (Subnet<4 | 6> | IPAddress<4 | 6>)[];
mode: "whitelist" | "blacklist";
validate: boolean;
};
}

credentials: {
authenticate: boolean;
password: string;
username: string;
}

ips: {
list: (Subnet<4 | 6> | IPAddress<4 | 6>)[];
mode: "whitelist" | "blacklist";
validate: boolean;
}

`Private` promises