import {RestTestServer} from 'test-rest/src/components/server.js'

public class | source

RestTestServer

This component is responsible for configuring and controlling the test-rest server.

Constructor Summary

Public Constructor
public	constructor(serverConfig: ServerConfig, hapiConfig: Object) Creates a new instance of RestTestServer.

Public Members
public get	endpoints: Array<Endpoint> Returns all the endpoints configured for the server.
public get	routes: Array<T> Returns all endpoint and nested endpoints generated routes as an array.

Public Methods
public	restart(callback: Function) Restarts the server.
public	start(callback: Function) Starts the server.
public	stop(callback: Function) Stops the server.

Creates a new instance of RestTestServer.

Name	Type	Attribute	Description
serverConfig	ServerConfig		The server configuration object.
hapiConfig	Object	optional	Optional configuration for the underlying Hapi-server. See http://hapijs.com/api#new-serveroptions for more information.

Returns all the endpoints configured for the server.

Returns all endpoint and nested endpoints generated routes as an array. Note that to ensure routing the array returned is from bottom-up.

Restarts the server.

Name	Type	Attribute	Description
callback	Function	optional	An optional callback that will be executed after a successful restart.

Starts the server.

Name	Type	Attribute	Description
callback	Function	optional	An optional callback that will be executed after a successful startup.

Stops the server.

Name	Type	Attribute	Description
callback	Function	optional	An optional callback that will be executed after a successful halt.