Skip to main content

Server

tw5-typed

tw5-typed / modules/server / Server

Class: Server

Defined in: src/modules/server/index.d.ts:32

A simple HTTP server with regexp-based routes

options: variables - optional hashmap of variables to set (a misnomer - they are really constant parameters) routes - optional array of routes to use wiki - reference to wiki object

Constructors​

Constructor​

new Server(options): Server

Defined in: src/modules/server/index.d.ts:75

Parameters​

options​

IServerOptions

Returns​

Server

Properties​

defaultVariables​

defaultVariables: object

Defined in: src/modules/server/index.d.ts:53

debug-level​

debug-level: string

gzip​

gzip: string

host​

host: string

port​

port: string

required-plugins​

required-plugins: string

root-render-type​

root-render-type: string

root-serve-type​

root-serve-type: string

root-tiddler​

root-tiddler: string

system-tiddler-render-template​

system-tiddler-render-template: string

system-tiddler-render-type​

system-tiddler-render-type: string

tiddler-render-template​

tiddler-render-template: string

tiddler-render-type​

tiddler-render-type: string

use-browser-cache​

use-browser-cache: string

Example​

{
     port: "8080",
     host: "127.0.0.1",
     "required-plugins": "$:/plugins/tiddlywiki/filesystem,$:/plugins/tiddlywiki/tiddlyweb",
     "root-tiddler": "$:/core/save/all",
     "root-render-type": "text/plain",
     "root-serve-type": "text/html",
     "tiddler-render-type": "text/html",
     "tiddler-render-template": "$:/core/templates/server/static.tiddler.html",
     "system-tiddler-render-type": "text/plain",
     "system-tiddler-render-template": "$:/core/templates/wikified-tiddler",
     "debug-level": "none",
     "gzip": "no",
     "use-browser-cache": "no"
   }

requestHandler​

requestHandler: ServerEndpointHandler

Defined in: src/modules/server/index.d.ts:69

routes​

routes: IRoute[]

Defined in: src/modules/server/index.d.ts:73

variables​

variables: Record<string, unknown>

Defined in: src/modules/server/index.d.ts:71

Methods​

addRoute()​

addRoute(route): void

Defined in: src/modules/server/index.d.ts:76

Parameters​

route​

IRoute

Returns​

void

close()​

close(): void

Defined in: src/modules/server/index.d.ts:100

Returns​

void

get()​

get(variableName): unknown

Defined in: src/modules/server/index.d.ts:77

Parameters​

variableName​

string

Returns​

unknown

isAuthorized()​

isAuthorized(authorizationType, username?): boolean

Defined in: src/modules/server/index.d.ts:96

Check whether a given user is authorized for the specified authorizationType ("readers" or "writers"). Pass null or undefined as the username to check for anonymous access

Parameters​

authorizationType​

"readers" | "writers"

username?​

string

Returns​

boolean

listen()​

listen(port?, host?, prefix?): void

Defined in: src/modules/server/index.d.ts:84

Listen for requests port: optional port number (falls back to value of "port" variable) host: optional host address (falls back to value of "host" variable) prefix: optional prefix (falls back to value of "path-prefix" variable)

Parameters​

port?​

string

host?​

string

prefix?​

string

Returns​

void

on()​

Call Signature​

on(eventName, callback): void

Defined in: src/modules/server/index.d.ts:86

Parameters​
eventName​

"error"

callback​

(error) => void

Returns​

void

Call Signature​

on(eventName, callback): void

Defined in: src/modules/server/index.d.ts:87

Parameters​
eventName​

"listening"

callback​

() => void

Returns​

void

Call Signature​

on(eventName, callback): void

Defined in: src/modules/server/index.d.ts:88

Parameters​
eventName​

string

callback​

(...arguments_) => unknown

Returns​

void