Home Reference Source 
import HostHttpServer from 'stencila-node/lib/host/HostHttpServer.js'
public class | source

HostHttpServer

A HTTP server for a Host

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public get

address: *

public get

port: *

public get

url: string: *

Get the URL of this server
Private Members
private
private

_host: *

private

_port: *

private

_server: *

Method Summary

Public Methods
public

call(request: *, response: *, name: *, method: *, data: *): *

Handle a request to call an instance method
public

create(request: *, response: *, type: *, options: *): *

Handle a request to create an instance
public

destroy(request: *, response: *, name: *): *

Handle a request to destroy an instance
public

error(request: *, response: *, status: *, error: *): *

General error handling
public

error400(request: *, response: *, details: *): *

Specific error handling functions
public

error403(request: *, response: *, details: *): *

public

error404(request: *, response: *, details: *): *

public

error500(request: *, response: *, error: *): *

public

get(request: *, response: *, name: *): *

Handle a request to get an instance
public

handle(request: *, response: *): *

Handle a HTTP request
public

home(request: *, response: *): *

Handle a request to home
public

manifest(request: *, response: *)

Handle a request to manifest
public

route(verb: string, path: string, authorized: Boolean): array

Route a HTTP request
public

shutdown(request: *, response: *, type: *, options: *): *

Handle a request to shutdown an environment
public

Start this server
public

startup(request: *, response: *, type: *, options: *): *

Handle a request to startup an environment
public

statico(request: *, response: *, path_: *): *

Handle a request for a static file
public

Stop this server

Public Constructors

public constructor() source

Public Members

public get address: * source

public get port: * source

public get url: string: * source

Get the URL of this server

Return:

string

Server's URL, null if not serving

Private Members

private _address: * source

private _host: * source

private _port: * source

private _server: * source

Public Methods

public call(request: *, response: *, name: *, method: *, data: *): * source

Handle a request to call an instance method

Params:

NameTypeAttributeDescription
request *
response *
name *
method *
data *

Return:

*

public create(request: *, response: *, type: *, options: *): * source

Handle a request to create an instance

Params:

NameTypeAttributeDescription
request *
response *
type *
options *

Return:

*

public destroy(request: *, response: *, name: *): * source

Handle a request to destroy an instance

Params:

NameTypeAttributeDescription
request *
response *
name *

Return:

*

public error(request: *, response: *, status: *, error: *): * source

General error handling

Params:

NameTypeAttributeDescription
request *
response *
status *
error *

Return:

*

public error400(request: *, response: *, details: *): * source

Specific error handling functions

Params:

NameTypeAttributeDescription
request *
response *
details *

Return:

*

public error403(request: *, response: *, details: *): * source

Params:

NameTypeAttributeDescription
request *
response *
details *

Return:

*

public error404(request: *, response: *, details: *): * source

Params:

NameTypeAttributeDescription
request *
response *
details *

Return:

*

public error500(request: *, response: *, error: *): * source

Params:

NameTypeAttributeDescription
request *
response *
error *

Return:

*

public get(request: *, response: *, name: *): * source

Handle a request to get an instance

Params:

NameTypeAttributeDescription
request *
response *
name *

Return:

*

public handle(request: *, response: *): * source

Handle a HTTP request

Params:

NameTypeAttributeDescription
request *
response *

Return:

*

public home(request: *, response: *): * source

Handle a request to home

Params:

NameTypeAttributeDescription
request *
response *

Return:

*

public manifest(request: *, response: *) source

Handle a request to manifest

Params:

NameTypeAttributeDescription
request *
response *

public route(verb: string, path: string, authorized: Boolean): array source

Route a HTTP request

Params:

NameTypeAttributeDescription
verb string

The request's HTTP verb (aka. "method") eg. GET
path string

The requested path
authorized Boolean

Is the request authorized

Return:

array

An array with first element being the method to call, and subsequent elements being the call arguments

public shutdown(request: *, response: *, type: *, options: *): * source

Handle a request to shutdown an environment

Params:

NameTypeAttributeDescription
request *
response *
type *
options *

Return:

*

public start(): Promise source

Start this server

Return:

Promise

public startup(request: *, response: *, type: *, options: *): * source

Handle a request to startup an environment

Params:

NameTypeAttributeDescription
request *
response *
type *
options *

Return:

*

public statico(request: *, response: *, path_: *): * source

Handle a request for a static file

Params:

NameTypeAttributeDescription
request *
response *
path_ *

Return:

*

public stop(): Promise source

Stop this server

Return:

Promise