@types/hapi__hapi

  • Version 20.0.12
  • Published
  • 232 kB
  • 8 dependencies
  • MIT license

Install

npm i @types/hapi__hapi
yarn add @types/hapi__hapi
pnpm add @types/hapi__hapi

Overview

TypeScript definitions for @hapi/hapi

Index

Functions

Classes

Interfaces

Type Aliases

Namespaces

Functions

function server

server: (opts?: ServerOptions) => Server;
  • Factory function to create a new server object (introduced in v17).

Classes

class Server

class Server {}
  • The server object is the main application container. The server manages all incoming requests along with all the facilities provided by the framework. Each server supports a single connection (e.g. listen to port 80). [See docs](https://github.com/hapijs/hapi/blob/master/API.md#server)

constructor

constructor(options?: ServerOptions);
  • Creates a new server object

    Parameter options

    server configuration object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serveroptions)

property app

app: ServerApplicationState;
  • Provides a safe place to store server-specific run-time application data without potential conflicts with the framework internals. The data can be accessed whenever the server is accessible. Initialized with an empty object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverapp)

property auth

readonly auth: ServerAuth;
  • Server Auth: properties and methods

property cache

cache: ServerCache;
  • [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-servercacheoptions)

property decorations

readonly decorations: { request: string[]; toolkit: string[]; server: string[] };
  • Provides access to the decorations already applied to various framework interfaces. The object must not be modified directly, but only through server.decorate. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverdecorations)

property events

events: ServerEvents;
  • Access: podium public interface. The server events emitter. Utilizes the podium with support for event criteria validation, channels, and filters. Use the following methods to interact with server.events: [server.events.emit(criteria, data)](https://github.com/hapijs/hapi/blob/master/API.md#server.events.emit()) - emit server events. [server.events.on(criteria, listener)](https://github.com/hapijs/hapi/blob/master/API.md#server.events.on()) - subscribe to all events. [server.events.once(criteria, listener)](https://github.com/hapijs/hapi/blob/master/API.md#server.events.once()) - subscribe to Other methods include: server.events.removeListener(name, listener), server.events.removeAllListeners(name), and server.events.hasListeners(name). [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverevents)

property info

readonly info: ServerInfo;
  • An object containing information about the server where: * id - a unique server identifier (using the format '{hostname}:{pid}:{now base36}'). * created - server creation timestamp. * started - server start timestamp (0 when stopped). * port - the connection port based on the following rules: * host - The host configuration value. * address - the active IP address the connection was bound to after starting. Set to undefined until the server has been started or when using a non TCP port (e.g. UNIX domain socket). * protocol - the protocol used: * 'http' - HTTP. * 'https' - HTTPS. * 'socket' - UNIX domain socket or Windows named pipe. * uri - a string representing the connection (e.g. 'http://example.com:8080' or 'socket:/unix/domain/socket/path'). Contains the uri value if set, otherwise constructed from the available settings. If no port is configured or is set to 0, the uri will not include a port component until the server is started. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverinfo)

property listener

listener: http.Server;
  • Access: read only and listener public interface. The node HTTP server object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverlistener)

property load

readonly load: { eventLoopDelay: number; heapUsed: number; rss: number };
  • An object containing the process load metrics (when load.sampleInterval is enabled): * eventLoopDelay - event loop delay milliseconds. * heapUsed - V8 heap usage. * rss - RSS memory usage. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverload)

property methods

readonly methods: ServerMethods;
  • Server methods are functions registered with the server and used throughout the application as a common utility. Their advantage is in the ability to configure them to use the built-in cache and share across multiple request handlers without having to create a common module. sever.methods is an object which provides access to the methods registered via server.method() where each server method name is an object property. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-servermethods

property mime

mime: any;
  • Provides access to the server MIME database used for setting content-type information. The object must not be modified directly but only through the [mime](https://github.com/hapijs/hapi/blob/master/API.md#server.options.mime) server setting. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-servermime)

property plugins

plugins: PluginProperties;
  • An object containing the values exposed by each registered plugin where each key is a plugin name and the values are the exposed properties by each plugin using server.expose(). Plugins may set the value of the server.plugins[name] object directly or via the server.expose() method. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverplugins)

property realm

readonly realm: ServerRealm;
  • The realm object contains sandboxed server settings specific to each plugin or authentication strategy. When registering a plugin or an authentication scheme, a server object reference is provided with a new server.realm container specific to that registration. It allows each plugin to maintain its own settings without leaking and affecting other plugins. For example, a plugin can set a default file path for local resources without breaking other plugins' configured paths. When calling server.bind(), the active realm's settings.bind property is set which is then used by routes and extensions added at the same level (server root or plugin). [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverrealm)

property registrations

readonly registrations: PluginsListRegistered;
  • An object of the currently registered plugins where each key is a registered plugin name and the value is an object containing: * version - the plugin version. * name - the plugin name. * options - (optional) options passed to the plugin during registration. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverregistrations)

property settings

readonly settings: ServerOptions;
  • The server configuration object after defaults applied. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serversettings)

property states

readonly states: ServerState;
  • The server cookies manager. Access: read only and statehood public interface. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverstates)

property type

readonly type: 'socket' | 'tcp';
  • A string indicating the listener type where: * 'socket' - UNIX domain socket or Windows named pipe. * 'tcp' - an HTTP listener.

property version

readonly version: string;
  • The hapi module version number.

method bind

bind: (context: object) => void;
  • Sets a global context used as the default bind object when adding a route or an extension where:

    Parameter context

    the object used to bind this in lifecycle methods such as the route handler and extension methods. The context is also made available as h.context. Return value: none. When setting a context inside a plugin, the context is applied only to methods set up by the plugin. Note that the context applies only to routes and extensions added after it has been set. Ignored if the method being bound is an arrow function. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverbindcontext)

method control

control: (server: Server) => void;
  • Links another server to the initialize/start/stop state of the current server by calling the controlled server initialize()/start()/stop() methods whenever the current server methods are called, where:

method decoder

decoder: (
encoding: string,
decoder: (options: PayloadCompressionDecoderSettings) => zlib.Gunzip
) => void;
  • Registers a custom content decoding compressor to extend the built-in support for 'gzip' and 'deflate' where:

    Parameter encoding

    the decoder name string.

    Parameter decoder

    a function using the signature function(options) where options are the encoding specific options configured in the route payload.compression configuration option, and the return value is an object compatible with the output of node's zlib.createGunzip(). Return value: none. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverdecoderencoding-decoder)

method decorate

decorate: {
(
type: 'handler',
property: DecorateName,
method: HandlerDecorationMethod,
options?: { apply?: boolean | undefined; extend?: boolean | undefined }
): void;
(
type: 'request',
property: DecorateName,
method: (
existing: (...args: any[]) => any
) => (request: Request) => DecorationMethod<Request>,
options: { apply: true; extend: true }
): void;
(
type: 'request',
property: DecorateName,
method: (request: Request) => DecorationMethod<Request>,
options: { apply: true; extend?: boolean }
): void;
(
type: 'request',
property: DecorateName,
method: DecorationMethod<Request>,
options?: { apply?: boolean; extend?: boolean }
): void;
(
type: 'toolkit',
property: DecorateName,
method: (
existing: (...args: any[]) => any
) => DecorationMethod<ResponseToolkit>,
options: { apply?: boolean; extend: true }
): void;
(
type: 'toolkit',
property: DecorateName,
method: DecorationMethod<ResponseToolkit>,
options?: { apply?: boolean; extend?: boolean }
): void;
(
type: 'server',
property: DecorateName,
method: (existing: (...args: any[]) => any) => DecorationMethod<Server>,
options: { apply?: boolean; extend: true }
): void;
(
type: 'server',
property: DecorateName,
method: DecorationMethod<Server>,
options?: { apply?: boolean; extend?: boolean }
): void;
};
  • Extends various framework interfaces with custom methods where:

    Parameter type

    the interface being decorated. Supported types: 'handler' - adds a new handler type to be used in routes handlers. 'request' - adds methods to the Request object. 'server' - adds methods to the Server object. 'toolkit' - adds methods to the response toolkit.

    Parameter property

    the object decoration key name.

    Parameter method

    the extension function or other value.

    Parameter options

    (optional) supports the following optional settings: apply - when the type is 'request', if true, the method function is invoked using the signature function(request) where request is the current request object and the returned value is assigned as the decoration. extend - if true, overrides an existing decoration. The method must be a function with the signature function(existing) where: existing - is the previously set decoration method value. must return the new decoration function or value. cannot be used to extend handler decorations. void; [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverdecoratetype-property-method-options)

method dependency

dependency: (
dependencies: Dependencies,
after?: (server: Server) => Promise<void>
) => void;
  • Used within a plugin to declare a required dependency on other plugins where:

    Parameter dependencies

    plugins which must be registered in order for this plugin to operate. Plugins listed must be registered before the server is initialized or started.

    Parameter after

    (optional) a function that is called after all the specified dependencies have been registered and before the server starts. The function is only called if the server is initialized or started. The function signature is async function(server) where: server - the server the dependency() method was called on. Return value: none. The after method is identical to setting a server extension point on 'onPreStart'. If a circular dependency is detected, an exception is thrown (e.g. two plugins each has an after function to be called after the other). The method does not provide version dependency which should be implemented using npm peer dependencies. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverdependencydependencies-after)

method encoder

encoder: (
encoding: string,
encoder: (options: RouteCompressionEncoderSettings) => zlib.Gzip
) => void;
  • Registers a custom content encoding compressor to extend the built-in support for 'gzip' and 'deflate' where:

    Parameter encoding

    the encoder name string.

    Parameter encoder

    a function using the signature function(options) where options are the encoding specific options configured in the route compression option, and the return value is an object compatible with the output of node's zlib.createGzip(). Return value: none. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverencoderencoding-encoder)

method event

event: (events: ServerEventsApplication | ServerEventsApplication[]) => void;
  • Register custom application events where:

    Parameter events

    must be one of: * an event name string. * an event options object with the following optional keys (unless noted otherwise): * * name - the event name string (required). * * channels - a string or array of strings specifying the event channels available. Defaults to no channel restrictions (event updates can specify a channel or not). * * clone - if true, the data object passed to server.events.emit() is cloned before it is passed to the listeners (unless an override specified by each listener). Defaults to false (data is passed as-is). * * spread - if true, the data object passed to server.event.emit() must be an array and the listener method is called with each array element passed as a separate argument (unless an override specified by each listener). This should only be used when the emitted data structure is known and predictable. Defaults to false (data is emitted as a single argument regardless of its type). * * tags - if true and the criteria object passed to server.event.emit() includes tags, the tags are mapped to an object (where each tag string is the key and the value is true) which is appended to the arguments list at the end. A configuration override can be set by each listener. Defaults to false. * * shared - if true, the same event name can be registered multiple times where the second registration is ignored. Note that if the registration config is changed between registrations, only the first configuration is used. Defaults to false (a duplicate registration will throw an error). * a podium emitter object. * an array containing any of the above. Return value: none. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverevents)

method expose

expose: { (key: string, value: any): void; (obj: object): void };
  • Used within a plugin to expose a property via server.plugins[name] where:

    Parameter key

    the key assigned (server.plugins[name][key]).

    Parameter value

    the value assigned. Return value: none. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverexposekey-value)

  • Merges an object into to the existing content of server.plugins[name] where:

    Parameter obj

    the object merged into the exposed properties container. Return value: none. Note that all the properties of obj are deeply cloned into server.plugins[name], so avoid using this method for exposing large objects that may be expensive to clone or singleton objects such as database client objects. Instead favor server.expose(key, value), which only copies a reference to value. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverexposeobj)

method ext

ext: {
(
events:
| ServerExtEventsObject
| ServerExtEventsObject[]
| ServerExtEventsRequestObject
| ServerExtEventsRequestObject[]
): void;
(
event: ServerExtType,
method: ServerExtPointFunction,
options?: ServerExtOptions
): void;
(
event: ServerRequestExtType,
method: Lifecycle.Method,
options?: ServerExtOptions
): void;
};
  • Registers an extension function in one of the request lifecycle extension points where:

    Parameter events

    an object or array of objects with the following: * type - (required) the extension point event name. The available extension points include the request extension points as well as the following server extension points: * * 'onPreStart' - called before the connection listeners are started. * * 'onPostStart' - called after the connection listeners are started. * * 'onPreStop' - called before the connection listeners are stopped. * * 'onPostStop' - called after the connection listeners are stopped. * method - (required) a function or an array of functions to be executed at a specified point during request processing. The required extension function signature is: * * server extension points: async function(server) where: * * * server - the server object. * * * this - the object provided via options.bind or the current active context set with server.bind(). * * request extension points: a lifecycle method. * options - (optional) an object with the following: * * before - a string or array of strings of plugin names this method must execute before (on the same event). Otherwise, extension methods are executed in the order added. * * after - a string or array of strings of plugin names this method must execute after (on the same event). Otherwise, extension methods are executed in the order added. * * bind - a context object passed back to the provided method (via this) when called. Ignored if the method is an arrow function. * * sandbox - if set to 'plugin' when adding a request extension points the extension is only added to routes defined by the current plugin. Not allowed when configuring route-level extensions, or when adding server extensions. Defaults to 'server' which applies to any route added to the server the extension is added to. void [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverextevents)

  • Registers a single extension event using the same properties as used in server.ext(events), but passed as arguments. Return value: none. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverextevent-method-options)

method initialize

initialize: () => Promise<void>;
  • Initializes the server (starts the caches, finalizes plugin registration) but does not start listening on the connection port. Return value: none. Note that if the method fails and throws an error, the server is considered to be in an undefined state and should be shut down. In most cases it would be impossible to fully recover as the various plugins, caches, and other event listeners will get confused by repeated attempts to start the server or make assumptions about the healthy state of the environment. It is recommended to abort the process when the server fails to start properly. If you must try to resume after an error, call server.stop() first to reset the server state. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-await-serverinitialize)

method inject

inject: (options: string | ServerInjectOptions) => Promise<ServerInjectResponse>;
  • Injects a request into the server simulating an incoming HTTP request without making an actual socket connection. Injection is useful for testing purposes as well as for invoking routing logic internally without the overhead and limitations of the network stack. The method utilizes the shot module for performing injections, with some additional options and response properties:

    Parameter options

    can be assigned a string with the requested URI, or an object with: * method - (optional) the request HTTP method (e.g. 'POST'). Defaults to 'GET'. * url - (required) the request URL. If the URI includes an authority (e.g. 'example.com:8080'), it is used to automatically set an HTTP 'Host' header, unless one was specified in headers. * headers - (optional) an object with optional request headers where each key is the header name and the value is the header content. Defaults to no additions to the default shot headers. * payload - (optional) an string, buffer or object containing the request payload. In case of an object it will be converted to a string for you. Defaults to no payload. Note that payload processing defaults to 'application/json' if no 'Content-Type' header provided. * credentials - (optional) an credentials object containing authentication information. The credentials are used to bypass the default authentication strategies, and are validated directly as if they were received via an authentication scheme. Defaults to no credentials. * artifacts - (optional) an artifacts object containing authentication artifact information. The artifacts are used to bypass the default authentication strategies, and are validated directly as if they were received via an authentication scheme. Ignored if set without credentials. Defaults to no artifacts. * app - (optional) sets the initial value of request.app, defaults to {}. * plugins - (optional) sets the initial value of request.plugins, defaults to {}. * allowInternals - (optional) allows access to routes with config.isInternal set to true. Defaults to false. * remoteAddress - (optional) sets the remote address for the incoming connection. * simulate - (optional) an object with options used to simulate client request stream conditions for testing: * error - if true, emits an 'error' event after payload transmission (if any). Defaults to false. * close - if true, emits a 'close' event after payload transmission (if any). Defaults to false. * end - if false, does not end the stream. Defaults to true. * split - indicates whether the request payload will be split into chunks. Defaults to undefined, meaning payload will not be chunked. * validate - (optional) if false, the options inputs are not validated. This is recommended for run-time usage of inject() to make it perform faster where input validation can be tested separately. Return value: a response object with the following properties: * statusCode - the HTTP status code. * headers - an object containing the headers set. * payload - the response payload string. * rawPayload - the raw response payload buffer. * raw - an object with the injection request and response objects: * req - the simulated node request object. * res - the simulated node response object. * result - the raw handler response (e.g. when not a stream or a view) before it is serialized for transmission. If not available, the value is set to payload. Useful for inspection and reuse of the internal objects returned (instead of parsing the response string). * request - the request object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-await-serverinjectoptions)

method log

log: (
tags: string | string[],
data?: string | object | (() => any),
timestamp?: number
) => void;
  • Logs server events that cannot be associated with a specific request. When called the server emits a 'log' event which can be used by other listeners or plugins to record the information or output to the console. The arguments are:

    Parameter tags

    (required) a string or an array of strings (e.g. ['error', 'database', 'read']) used to identify the event. Tags are used instead of log levels and provide a much more expressive mechanism for describing and filtering events. Any logs generated by the server internally include the 'hapi' tag along with event-specific information.

    Parameter data

    (optional) an message string or object with the application data being logged. If data is a function, the function signature is function() and it called once to generate (return value) the actual data emitted to the listeners. If no listeners match the event, the data function is not invoked.

    Parameter timestamp

    (optional) an timestamp expressed in milliseconds. Defaults to Date.now() (now). Return value: none. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverlogtags-data-timestamp)

method lookup

lookup: (id: string) => RequestRoute | null;
  • Looks up a route configuration where:

    Parameter id

    the route identifier. Return value: the route information if found, otherwise null. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverlookupid)

method match

match: (
method: Util.HTTP_METHODS,
path: string,
host?: string
) => RequestRoute | null;
  • Looks up a route configuration where:

    Parameter method

    the HTTP method (e.g. 'GET', 'POST').

    Parameter path

    the requested path (must begin with '/').

    Parameter host

    (optional) hostname (to match against routes with vhost). Return value: the route information if found, otherwise null. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-servermatchmethod-path-host)

method method

method: {
(name: string, method: ServerMethod, options?: ServerMethodOptions): void;
(
methods:
| ServerMethodConfigurationObject
| ServerMethodConfigurationObject[]
): void;
};
  • Registers a server method where:

    Parameter name

    a unique method name used to invoke the method via server.methods[name].

    Parameter method

    the method function with a signature async function(...args, [flags]) where: * ...args - the method function arguments (can be any number of arguments or none). * flags - when caching is enabled, an object used to set optional method result flags: * * ttl - 0 if result is valid but cannot be cached. Defaults to cache policy.

    Parameter options

    (optional) configuration object: * bind - a context object passed back to the method function (via this) when called. Defaults to active context (set via server.bind() when the method is registered. Ignored if the method is an arrow function. * cache - the same cache configuration used in server.cache(). The generateTimeout option is required. * generateKey - a function used to generate a unique key (for caching) from the arguments passed to the method function (the flags argument is not passed as input). The server will automatically generate a unique key if the function's arguments are all of types 'string', 'number', or 'boolean'. However if the method uses other types of arguments, a key generation function must be provided which takes the same arguments as the function and returns a unique string (or null if no key can be generated). Return value: none. Method names can be nested (e.g. utils.users.get) which will automatically create the full path under server.methods (e.g. accessed via server.methods.utils.users.get). When configured with caching enabled, server.methods[name].cache is assigned an object with the following properties and methods: - await drop(...args) - a function that can be used to clear the cache for a given key. - stats - an object with cache statistics, see catbox for stats documentation. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-servermethodname-method-options)

  • Registers a server method function as described in server.method() using a configuration object where:

    Parameter methods

    an object or an array of objects where each one contains: * name - the method name. * method - the method function. * options - (optional) settings. Return value: none. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-servermethodmethods)

method path

path: (relativeTo: string) => void;
  • Sets the path prefix used to locate static resources (files and view templates) when relative paths are used where:

    Parameter relativeTo

    the path prefix added to any relative file path starting with '.'. Return value: none. Note that setting a path within a plugin only applies to resources accessed by plugin methods. If no path is set, the server default route configuration files.relativeTo settings is used. The path only applies to routes added after it has been set. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverpathrelativeto)

method register

register: {
<T>(
plugin: ServerRegisterPluginObject<T>,
options?: ServerRegisterOptions
): Promise<void>;
<T, U, V, W, X, Y, Z>(
plugins: ServerRegisterPluginObjectArray<T, U, V, W, X, Y, Z>,
options?: ServerRegisterOptions
): Promise<void>;
(
plugins: ServerRegisterPluginObject<any>[],
options?: ServerRegisterOptions
): Promise<void>;
(
plugins: Plugin<any> | Plugin<any>[],
options?: ServerRegisterOptions
): Promise<void>;
};
  • Registers a plugin where:

    Parameter plugins

    one or an array of: * a plugin object. * an object with the following: * * plugin - a plugin object. * * options - (optional) options passed to the plugin during registration. * * once, routes - (optional) plugin-specific registration options as defined below.

    Parameter options

    (optional) registration options (different from the options passed to the registration function): * once - if true, subsequent registrations of the same plugin are skipped without error. Cannot be used with plugin options. Defaults to false. If not set to true, an error will be thrown the second time a plugin is registered on the server. * routes - modifiers applied to each route added by the plugin: * * prefix - string added as prefix to any route path (must begin with '/'). If a plugin registers a child plugin the prefix is passed on to the child or is added in front of the child-specific prefix. * * vhost - virtual host string (or array of strings) applied to every route. The outer-most vhost overrides the any nested configuration. Return value: none. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-await-serverregisterplugins-options)

method route

route: (route: ServerRoute | ServerRoute[]) => void;
  • Adds a route where:

    Parameter route

    a route configuration object or an array of configuration objects where each object contains: * path - (required) the absolute path used to match incoming requests (must begin with '/'). Incoming requests are compared to the configured paths based on the server's router configuration. The path can include named parameters enclosed in {} which will be matched against literal values in the request as described in Path parameters. * method - (required) the HTTP method. Typically one of 'GET', 'POST', 'PUT', 'PATCH', 'DELETE', or 'OPTIONS'. Any HTTP method is allowed, except for 'HEAD'. Use '*' to match against any HTTP method (only when an exact match was not found, and any match with a specific method will be given a higher priority over a wildcard match). Can be assigned an array of methods which has the same result as adding the same route with different methods manually. * vhost - (optional) a domain string or an array of domain strings for limiting the route to only requests with a matching host header field. Matching is done against the hostname part of the header only (excluding the port). Defaults to all hosts. * handler - (required when handler is not set) the route handler function called to generate the response after successful authentication and validation. * options - additional route options. The options value can be an object or a function that returns an object using the signature function(server) where server is the server the route is being added to and this is bound to the current realm's bind option. * rules - route custom rules object. The object is passed to each rules processor registered with server.rules(). Cannot be used if route.options.rules is defined. Return value: none. Note that the options object is deeply cloned (with the exception of bind which is shallowly copied) and cannot contain any values that are unsafe to perform deep copy on. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverrouteroute)

method rules

rules: (
processor: (
rules: object,
info: { method: string; path: string; vhost?: string | undefined }
) => object,
options?: { validate: object }
) => void;
  • Defines a route rules processor for converting route rules object into route configuration where:

    Parameter processor

    a function using the signature function(rules, info) where: * rules - * info - an object with the following properties: * * method - the route method. * * path - the route path. * * vhost - the route virtual host (if any defined). * returns a route config object.

    Parameter options

    optional settings: * validate - rules object validation: * * schema - joi schema. * * options - optional joi validation options. Defaults to { allowUnknown: true }. Note that the root server and each plugin server instance can only register one rules processor. If a route is added after the rules are configured, it will not include the rules config. Routes added by plugins apply the rules to each of the parent realms' rules from the root to the route's realm. This means the processor defined by the plugin override the config generated by the root processor if they overlap. The route config overrides the rules config if the overlap. void [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverrulesprocessor-options)

method start

start: () => Promise<void>;
  • Starts the server by listening for incoming requests on the configured port (unless the connection was configured with autoListen set to false). Return value: none. Note that if the method fails and throws an error, the server is considered to be in an undefined state and should be shut down. In most cases it would be impossible to fully recover as the various plugins, caches, and other event listeners will get confused by repeated attempts to start the server or make assumptions about the healthy state of the environment. It is recommended to abort the process when the server fails to start properly. If you must try to resume after an error, call server.stop() first to reset the server state. If a started server is started again, the second call to server.start() is ignored. No events will be emitted and no extension points invoked. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-await-serverstart)

method state

state: (name: string, options?: ServerStateCookieOptions) => void;
  • HTTP state management uses client cookies to persist a state across multiple requests.

    Parameter name

    the cookie name string.

    Parameter options

    are the optional cookie settings Return value: none. State defaults can be modified via the server default state configuration option. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverstatename-options)

method stop

stop: (options?: { timeout: number }) => Promise<void>;
  • Stops the server's listener by refusing to accept any new connections or requests (existing connections will continue until closed or timeout), where:

    Parameter options

    (optional) object with: * timeout - overrides the timeout in millisecond before forcefully terminating a connection. Defaults to 5000 (5 seconds). Return value: none. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-await-serverstopoptions)

method table

table: (host?: string) => RequestRoute[];
  • Returns a copy of the routing table where:

    Parameter host

    (optional) host to filter routes matching a specific virtual host. Defaults to all virtual hosts. Return value: an array of routes where each route contains: * settings - the route config with defaults applied. * method - the HTTP method in lower case. * path - the route path. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-servertablehost)

method validator

validator: (joi: Root) => void;
  • Registers a server validation module used to compile raw validation rules into validation schemas for all routes. The validator is only used when validation rules are not pre-compiled schemas. When a validation rules is a function or schema object, the rule is used as-is and the validator is not used.

Interfaces

interface AccessScopes

interface AccessScopes {}

    property forbidden

    forbidden?: string[] | undefined;

      property required

      required?: string[] | undefined;

        property selection

        selection?: string[] | undefined;

          interface AccessSetting

          interface AccessSetting {}

            property entity

            entity?: AccessEntity | undefined;

              property scope

              scope: AccessScopes | false;

                interface AppCredentials

                interface AppCredentials {}
                • User extensible types app credentials.

                interface Auth

                interface Auth {}

                  property data

                  readonly data?: AuthenticationData | undefined;

                    property error

                    readonly error?: Error | null | undefined;

                      property isAuth

                      readonly isAuth: true;

                        interface AuthArtifacts

                        interface AuthArtifacts {}

                          index signature

                          [key: string]: unknown;

                            interface AuthCredentials

                            interface AuthCredentials {}
                            • User-extensible type for request.auth credentials.

                            property app

                            app?: AppCredentials | undefined;
                            • If set, will only work with routes that set access.entity to app.

                            property scope

                            scope?: string[] | undefined;
                            • The application scopes to be granted. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsauthaccessscope)

                            property user

                            user?: UserCredentials | undefined;
                            • If set, will only work with routes that set access.entity to user.

                            index signature

                            [key: string]: unknown;

                              interface AuthenticationData

                              interface AuthenticationData {}

                                property artifacts

                                artifacts?: AuthArtifacts | undefined;

                                  property credentials

                                  credentials: AuthCredentials;

                                    interface AuthSettings

                                    interface AuthSettings {}

                                      property access

                                      access?: AccessSetting[] | undefined;

                                        property mode

                                        mode: AuthMode;

                                          property strategies

                                          strategies: string[];

                                            interface CommonRouteProperties

                                            interface CommonRouteProperties {}

                                              property app

                                              app?: RouteOptionsApp | undefined;
                                              • Application-specific route configuration state. Should not be used by plugins which should use options.plugins[name] instead. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsapp)

                                              property bind

                                              bind?: object | null | undefined;
                                              • null. An object passed back to the provided handler (via this) when called. Ignored if the method is an arrow function. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsbind)

                                              property cache

                                              cache?: false | RouteOptionsCache | undefined;
                                              • { privacy: 'default', statuses: [200], otherwise: 'no-cache' }. If the route method is 'GET', the route can be configured to include HTTP caching directives in the response. Caching can be customized using an object with the following options: privacy - determines the privacy flag included in client-side caching using the 'Cache-Control' header. Values are: * * 'default' - no privacy flag. * * 'public' - mark the response as suitable for public caching. * * 'private' - mark the response as suitable only for private caching. * expiresIn - relative expiration expressed in the number of milliseconds since the item was saved in the cache. Cannot be used together with expiresAt. * expiresAt - time of day expressed in 24h notation using the 'HH:MM' format, at which point all cache records for the route expire. Cannot be used together with expiresIn. * statuses - an array of HTTP response status code numbers (e.g. 200) which are allowed to include a valid caching directive. * otherwise - a string with the value of the 'Cache-Control' header when caching is disabled. The default Cache-Control: no-cache header can be disabled by setting cache to false. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionscache)

                                              property compression

                                              compression?: Util.Dictionary<RouteCompressionEncoderSettings> | undefined;
                                              • An object where each key is a content-encoding name and each value is an object with the desired encoder settings. Note that decoder settings are set in compression. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionscompression)

                                              property cors

                                              cors?: boolean | RouteOptionsCors | undefined;
                                              • false (no CORS headers). The Cross-Origin Resource Sharing protocol allows browsers to make cross-origin API calls. CORS is required by web applications running inside a browser which are loaded from a different domain than the API server. To enable, set cors to true, or to an object with the following options: * origin - an array of allowed origin servers strings ('Access-Control-Allow-Origin'). The array can contain any combination of fully qualified origins along with origin strings containing a wildcard '*' character, or a single '*' origin string. If set to 'ignore', any incoming Origin header is ignored (present or not) and the 'Access-Control-Allow-Origin' header is set to '*'. Defaults to any origin ['*']. * maxAge - number of seconds the browser should cache the CORS response ('Access-Control-Max-Age'). The greater the value, the longer it will take before the browser checks for changes in policy. Defaults to 86400 (one day). * headers - a strings array of allowed headers ('Access-Control-Allow-Headers'). Defaults to ['Accept', 'Authorization', 'Content-Type', 'If-None-Match']. * additionalHeaders - a strings array of additional headers to headers. Use this to keep the default headers in place. * exposedHeaders - a strings array of exposed headers ('Access-Control-Expose-Headers'). Defaults to ['WWW-Authenticate', 'Server-Authorization']. * additionalExposedHeaders - a strings array of additional headers to exposedHeaders. Use this to keep the default headers in place. * credentials - if true, allows user credentials to be sent ('Access-Control-Allow-Credentials'). Defaults to false. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionscors)

                                              property description

                                              description?: string | undefined;
                                              • none. Route description used for generating documentation (string). This setting is not available when setting server route defaults using server.options.routes. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsdescription)

                                              property ext

                                              ext?:
                                              | {
                                              [key in RouteRequestExtType]?: RouteExtObject | RouteExtObject[];
                                              }
                                              | undefined;
                                              • none. Route-level request extension points by setting the option to an object with a key for each of the desired extension points ('onRequest' is not allowed), and the value is the same as the server.ext(events) event argument. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsext) [See docs](https://github.com/hapijs/hapi/blob/master/API.md#request-lifecycle)

                                              property files

                                              files?:
                                              | {
                                              relativeTo: string;
                                              }
                                              | undefined;
                                              • { relativeTo: '.' }. Defines the behavior for accessing files: * relativeTo - determines the folder relative paths are resolved against. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsfiles)

                                              property handler

                                              handler?: Lifecycle.Method | object | undefined;
                                              • none. The route handler function performs the main business logic of the route and sets the response. handler can be assigned: * a lifecycle method. * an object with a single property using the name of a handler type registred with the server.handler() method. The matching property value is passed as options to the registered handler generator. Note: handlers using a fat arrow style function cannot be bound to any bind property. Instead, the bound context is available under h.context. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionshandler)

                                              property id

                                              id?: string | undefined;
                                              • none. An optional unique identifier used to look up the route using server.lookup(). Cannot be assigned to routes added with an array of methods. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsid)

                                              property isInternal

                                              isInternal?: boolean | undefined;
                                              • false. If true, the route cannot be accessed through the HTTP listener but only through the server.inject() interface with the allowInternals option set to true. Used for internal routes that should not be accessible to the outside world. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsisinternal)

                                              property json

                                              json?: Json.StringifyArguments | undefined;
                                              • none. Optional arguments passed to JSON.stringify() when converting an object or error response to a string payload or escaping it after stringification. Supports the following: * replacer - the replacer function or array. Defaults to no action. * space - number of spaces to indent nested object keys. Defaults to no indentation. * suffix - string suffix added after conversion to JSON string. Defaults to no suffix. * escape - calls Hoek.jsonEscape() after conversion to JSON string. Defaults to false. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsjson)

                                              property jsonp

                                              jsonp?: string | undefined;
                                              • none. Enables JSONP support by setting the value to the query parameter name containing the function name used to wrap the response payload. For example, if the value is 'callback', a request comes in with 'callback=me', and the JSON response is '{ "a":"b" }', the payload will be 'me({ "a":"b" });'. Cannot be used with stream responses. The 'Content-Type' response header is set to 'text/javascript' and the 'X-Content-Type-Options' response header is set to 'nosniff', and will override those headers even if explicitly set by response.type(). [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsjsonp)

                                              property log

                                              log?:
                                              | {
                                              collect: boolean;
                                              }
                                              | undefined;
                                              • { collect: false }. Request logging options: collect - if true, request-level logs (both internal and application) are collected and accessible via request.logs. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionslog)

                                              property notes

                                              notes?: string | string[] | undefined;
                                              • none. Route notes used for generating documentation (string or array of strings). This setting is not available when setting server route defaults using server.options.routes. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsnotes)

                                              property payload

                                              payload?: RouteOptionsPayload | undefined;
                                              • Determines how the request payload is processed. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionspayload)

                                              property plugins

                                              plugins?: PluginSpecificConfiguration | undefined;
                                              • {}. Plugin-specific configuration. plugins is an object where each key is a plugin name and the value is the plugin configuration. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsplugins)

                                              property pre

                                              pre?: RouteOptionsPreArray | undefined;
                                              • none. The pre option allows defining methods for performing actions before the handler is called. These methods allow breaking the handler logic into smaller, reusable components that can be shared ascross routes, as well as provide a cleaner error handling of prerequisite operations (e.g. load required reference data from a database). pre is assigned an ordered array of methods which are called serially in order. If the pre array contains another array of methods as one of its elements, those methods are called in parallel. Note that during parallel execution, if any of the methods error, return a takeover response, or abort signal, the other parallel methods will continue to execute but will be ignored once completed. pre can be assigned a mixed array of: * an array containing the elements listed below, which are executed in parallel. * an object with: * * method - a lifecycle method. * * assign - key name used to assign the response of the method to in request.pre and request.preResponses. * * failAction - A failAction value which determine what to do when a pre-handler method throws an error. If assign is specified and the failAction setting is not 'error', the error will be assigned. * a method function - same as including an object with a single method key. Note that pre-handler methods do not behave the same way other lifecycle methods do when a value is returned. Instead of the return value becoming the new response payload, the value is used to assign the corresponding request.pre and request.preResponses properties. Otherwise, the handling of errors, takeover response response, or abort signal behave the same as any other lifecycle methods. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionspre)

                                              property response

                                              response?: RouteOptionsResponse | undefined;
                                              • Processing rules for the outgoing response. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsresponse)

                                              property security

                                              security?: RouteOptionsSecure | undefined;
                                              • false (security headers disabled). [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionssecurity)

                                              property state

                                              state?:
                                              | {
                                              parse?: boolean | undefined;
                                              failAction?: Lifecycle.FailAction | undefined;
                                              }
                                              | undefined;
                                              • { parse: true, failAction: 'error' }. HTTP state management (cookies) allows the server to store information on the client which is sent back to the server with every request (as defined in RFC 6265). state supports the following options: parse - determines if incoming 'Cookie' headers are parsed and stored in the request.state object. failAction - A failAction value which determines how to handle cookie parsing errors. Defaults to 'error' (return a Bad Request (400) error response). [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsstate)

                                              property tags

                                              tags?: string[] | undefined;
                                              • none. Route tags used for generating documentation (array of strings). This setting is not available when setting server route defaults using server.options.routes. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionstags)

                                              property timeout

                                              timeout?:
                                              | {
                                              /**
                                              * Response timeout in milliseconds. Sets the maximum time allowed for the server to respond to an incoming request before giving up and responding with a Service Unavailable (503) error
                                              * response.
                                              */
                                              server?: boolean | number | undefined;
                                              /**
                                              * @default none (use node default of 2 minutes).
                                              * By default, node sockets automatically timeout after 2 minutes. Use this option to override this behavior. Set to false to disable socket timeouts.
                                              */
                                              socket?: boolean | number | undefined;
                                              }
                                              | undefined;
                                              • { server: false }. Timeouts for processing durations. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionstimeout)

                                              property validate

                                              validate?: RouteOptionsValidate | undefined;
                                              • { headers: true, params: true, query: true, payload: true, failAction: 'error' }. Request input validation rules for various request components. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsvalidate)

                                              interface HandlerDecorationMethod

                                              interface HandlerDecorationMethod {}
                                              • The method function can have a defaults object or function property. If the property is set to an object, that object is used as the default route config for routes using this handler. If the property is set to a function, the function uses the signature function(method) and returns the route default configuration.

                                              property defaults

                                              defaults?: RouteOptions | ((method: any) => RouteOptions) | undefined;

                                                call signature

                                                (route: RequestRoute, options: any): Lifecycle.Method;

                                                  interface HandlerDecorations

                                                  interface HandlerDecorations {}

                                                    interface LogEvent

                                                    interface LogEvent {}

                                                      property channel

                                                      channel: 'internal' | 'app';
                                                      • set to 'internal' for internally generated events, otherwise 'app' for events generated by server.log()

                                                      property data

                                                      data: object;
                                                      • event-specific information. Available when event data was provided and is not an error. Errors are passed via error.

                                                      property error

                                                      error: object;
                                                      • the error object related to the event if applicable. Cannot appear together with data

                                                      property request

                                                      request: string;
                                                      • the request identifier.

                                                      property tags

                                                      tags: string[];
                                                      • an array of tags identifying the event (e.g. ['error', 'http'])

                                                      property timestamp

                                                      timestamp: string;
                                                      • the event timestamp.

                                                      interface PluginBase

                                                      interface PluginBase<T> {}
                                                      • Plugins provide a way to organize application code by splitting the server logic into smaller components. Each plugin can manipulate the server through the standard server interface, but with the added ability to sandbox certain properties. For example, setting a file path in one plugin doesn't affect the file path set in another plugin. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#plugins)

                                                        The type T is the type of the plugin options.

                                                      property dependencies

                                                      dependencies?: Dependencies | undefined;
                                                      • (optional) a string or an array of strings indicating a plugin dependency. Same as setting dependencies via server.dependency().

                                                      property multiple

                                                      multiple?: boolean | undefined;
                                                      • (optional) if true, allows the plugin to be registered multiple times with the same server. Defaults to false.

                                                      property once

                                                      once?: boolean | undefined;
                                                      • once - (optional) if true, will only register the plugin once per server. If set, overrides the once option passed to server.register(). Defaults to no override.

                                                      property register

                                                      register: (server: Server, options: T) => void | Promise<void>;
                                                      • (required) the registration function with the signature async function(server, options) where: * server - the server object with a plugin-specific server.realm. * options - any options passed to the plugin during registration via server.register().

                                                      property requirements

                                                      requirements?:
                                                      | {
                                                      node?: string | undefined;
                                                      hapi?: string | undefined;
                                                      }
                                                      | undefined;
                                                      • Allows defining semver requirements for node and hapi. Allows all.

                                                      interface PluginNameVersion

                                                      interface PluginNameVersion {}

                                                        property name

                                                        name: string;
                                                        • (required) the plugin name string. The name is used as a unique key. Published plugins (e.g. published in the npm registry) should use the same name as the name field in their 'package.json' file. Names must be unique within each application.

                                                        property version

                                                        version?: string | undefined;
                                                        • optional plugin version. The version is only used informatively to enable other plugins to find out the versions loaded. The version should be the same as the one specified in the plugin's 'package.json' file.

                                                        interface PluginPackage

                                                        interface PluginPackage {}

                                                          property pkg

                                                          pkg: any;
                                                          • Alternatively, the name and version can be included via the pkg property containing the 'package.json' file for the module which already has the name and version included

                                                          interface PluginProperties

                                                          interface PluginProperties {}
                                                          • An empty interface to allow typings of custom plugin properties.

                                                          interface PluginRegistered

                                                          interface PluginRegistered {}
                                                          • An object of the currently registered plugins where each key is a registered plugin name and the value is an object containing: * version - the plugin version. * name - the plugin name. * options - (optional) options passed to the plugin during registration. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverregistrations)

                                                          property name

                                                          name: string;
                                                          • the plugin name.

                                                          property options

                                                          options: object;
                                                          • options used to register the plugin.

                                                          property version

                                                          version: string;
                                                          • the plugin version.

                                                          interface PluginsListRegistered

                                                          interface PluginsListRegistered {}
                                                          • [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverregistrations)

                                                          interface PluginSpecificConfiguration

                                                          interface PluginSpecificConfiguration {}

                                                            interface PluginsStates

                                                            interface PluginsStates {}

                                                              interface PodiumEvent

                                                              interface PodiumEvent<K extends string, T> {}

                                                                method emit

                                                                emit: (criteria: K, listener: (value: T) => void) => void;

                                                                  method hasListeners

                                                                  hasListeners: (criteria: K) => this;

                                                                    method on

                                                                    on: (criteria: K, listener: (value: T) => void) => void;

                                                                      method once

                                                                      once: {
                                                                      (criteria: K, listener: (value: T) => void): void;
                                                                      (criteria: K): Promise<T>;
                                                                      };

                                                                        method removeAllListeners

                                                                        removeAllListeners: (criteria: K) => this;

                                                                          method removeListener

                                                                          removeListener: (criteria: K, listener: Podium.Listener) => this;

                                                                            interface Request

                                                                            interface Request extends Podium {}
                                                                            • The request object is created internally for each incoming request. It is not the same object received from the node HTTP server callback (which is available via [request.raw.req](https://github.com/hapijs/hapi/blob/master/API.md#request.raw)). The request properties change throughout the request [lifecycle](https://github.com/hapijs/hapi/blob/master/API.md#request-lifecycle).

                                                                            property app

                                                                            app: RequestApplicationState;
                                                                            • Application-specific state. Provides a safe place to store application data without potential conflicts with the framework. Should not be used by plugins which should use plugins[name]. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-requestapp)

                                                                            property auth

                                                                            readonly auth: RequestAuth;
                                                                            • Authentication information: * artifacts - an artifact object received from the authentication strategy and used in authentication-related actions. * credentials - the credential object received during the authentication process. The presence of an object does not mean successful authentication. * error - the authentication error is failed and mode set to 'try'. * isAuthenticated - true if the request has been successfully authenticated, otherwise false. * isAuthorized - true is the request has been successfully authorized against the route authentication access configuration. If the route has not access rules defined or if the request failed authorization, set to false. * mode - the route authentication mode. * strategy - the name of the strategy used. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-requestauth)

                                                                            property events

                                                                            events: RequestEvents;
                                                                            • Access: read only and the public podium interface. The request.events supports the following events: * 'peek' - emitted for each chunk of payload data read from the client connection. The event method signature is function(chunk, encoding). * 'finish' - emitted when the request payload finished reading. The event method signature is function (). * 'disconnect' - emitted when a request errors or aborts unexpectedly. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-requestevents)

                                                                            property headers

                                                                            readonly headers: Util.Dictionary<string>;
                                                                            • The raw request headers (references request.raw.req.headers). [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-requestheaders)

                                                                            property info

                                                                            readonly info: RequestInfo;
                                                                            • Request information: * acceptEncoding - the request preferred encoding. * cors - if CORS is enabled for the route, contains the following: * isOriginMatch - true if the request 'Origin' header matches the configured CORS restrictions. Set to false if no 'Origin' header is found or if it does not match. Note that this is only available after the 'onRequest' extension point as CORS is configured per-route and no routing decisions are made at that point in the request lifecycle. * host - content of the HTTP 'Host' header (e.g. 'example.com:8080'). * hostname - the hostname part of the 'Host' header (e.g. 'example.com'). * id - a unique request identifier (using the format '{now}:{connection.info.id}:{5 digits counter}'). * received - request reception timestamp. * referrer - content of the HTTP 'Referrer' (or 'Referer') header. * remoteAddress - remote client IP address. * remotePort - remote client port. * responded - request response timestamp (0 is not responded yet). Note that the request.info object is not meant to be modified. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-requestinfo)

                                                                            property logs

                                                                            readonly logs: RequestLog[];
                                                                            • An array containing the logged request events. Note that this array will be empty if route log.collect is set to false.

                                                                            property method

                                                                            readonly method: Util.HTTP_METHODS_PARTIAL_LOWERCASE;
                                                                            • The request method in lower case (e.g. 'get', 'post').

                                                                            property mime

                                                                            readonly mime: string;
                                                                            • The parsed content-type header. Only available when payload parsing enabled and no payload error occurred.

                                                                            property orig

                                                                            readonly orig: RequestOrig;
                                                                            • An object containing the values of params, query, and payload before any validation modifications made. Only set when input validation is performed.

                                                                            property params

                                                                            readonly params: Util.Dictionary<any>;
                                                                            • An object where each key is a path parameter name with matching value as described in [Path parameters](https://github.com/hapijs/hapi/blob/master/API.md#path-parameters).

                                                                            property paramsArray

                                                                            readonly paramsArray: string[];
                                                                            • An array containing all the path params values in the order they appeared in the path.

                                                                            property path

                                                                            readonly path: string;
                                                                            • The request URI's pathname component.

                                                                            property payload

                                                                            readonly payload: stream.Readable | Buffer | string | object;
                                                                            • The request payload based on the route payload.output and payload.parse settings. TODO check this typing and add references / links.

                                                                            property plugins

                                                                            plugins: PluginsStates;
                                                                            • Plugin-specific state. Provides a place to store and pass request-level plugin data. The plugins is an object where each key is a plugin name and the value is the state.

                                                                            property pre

                                                                            readonly pre: Util.Dictionary<any>;
                                                                            • An object where each key is the name assigned by a route pre-handler methods function. The values are the raw values provided to the continuation function as argument. For the wrapped response object, use responses.

                                                                            property preResponses

                                                                            readonly preResponses: Util.Dictionary<any>;
                                                                            • Same as pre but represented as the response object created by the pre method.

                                                                            property query

                                                                            readonly query: RequestQuery;
                                                                            • By default the object outputted from node's URL parse() method.

                                                                            property raw

                                                                            readonly raw: {
                                                                            req: http.IncomingMessage;
                                                                            res: http.ServerResponse;
                                                                            };
                                                                            • An object containing the Node HTTP server objects. Direct interaction with these raw objects is not recommended. * req - the node request object. * res - the node response object.

                                                                            property response

                                                                            response: ResponseObject | Boom;
                                                                            • Access: read / write (see limitations below). The response object when set. The object can be modified but must not be assigned another object. To replace the response with another from within an extension point, use reply(response) to override with a different response. In case of an aborted request the status code will be set to disconnectStatusCode.

                                                                            property route

                                                                            readonly route: RequestRoute;
                                                                            • The request route information object and method [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-requestroute) [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-requestrouteauthaccessrequest)

                                                                            property server

                                                                            server: Server;
                                                                            • Access: read only and the public server interface. The server object.

                                                                            property state

                                                                            readonly state: Util.Dictionary<any>;
                                                                            • An object containing parsed HTTP state information (cookies) where each key is the cookie name and value is the matching cookie content after processing using any registered cookie definition.

                                                                            property url

                                                                            readonly url: url.URL;
                                                                            • The parsed request URI.

                                                                            method active

                                                                            active: () => boolean;
                                                                            • Returns true when the request is active and processing should continue and false when the request terminated early or completed its lifecycle. Useful when request processing is a resource-intensive operation and should be terminated early if the request is no longer active (e.g. client disconnected or aborted early).

                                                                            method generateResponse

                                                                            generateResponse: (
                                                                            source: string | object | null,
                                                                            options?: {
                                                                            variety?: string | undefined;
                                                                            prepare?: (response: ResponseObject) => Promise<ResponseObject>;
                                                                            marshal?: (response: ResponseObject) => Promise<ResponseValue>;
                                                                            close?: (response: ResponseObject) => void;
                                                                            }
                                                                            ) => ResponseObject;
                                                                            • Returns a response which you can pass into the reply interface where:

                                                                              Parameter source

                                                                              the value to set as the source of the reply interface, optional.

                                                                              Parameter options

                                                                              options for the method, optional. ResponseObject [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-requestgenerateresponsesource-options)

                                                                            method log

                                                                            log: (
                                                                            tags: string | string[],
                                                                            data?: string | object | (() => string | object)
                                                                            ) => void;
                                                                            • Logs request-specific events. When called, the server emits a 'request' event which can be used by other listeners or plugins. The arguments are:

                                                                              Parameter tags

                                                                              a string or an array of strings (e.g. ['error', 'database', 'read']) used to identify the event. Tags are used instead of log levels and provide a much more expressive mechanism for describing and filtering events.

                                                                              Parameter data

                                                                              (optional) an message string or object with the application data being logged. If data is a function, the function signature is function() and it called once to generate (return value) the actual data emitted to the listeners. Any logs generated by the server internally will be emitted only on the 'request-internal' channel and will include the event.internal flag set to true. void [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-requestlogtags-data)

                                                                            method setMethod

                                                                            setMethod: (method: Util.HTTP_METHODS_PARTIAL) => void;
                                                                            • Changes the request method before the router begins processing the request where:

                                                                              Parameter method

                                                                              is the request HTTP method (e.g. 'GET'). void Can only be called from an 'onRequest' extension method. [See docs](https://hapijs.com/api/17.0.1#-requestsetmethodmethod)

                                                                            method setUrl

                                                                            setUrl: (url: string | url.URL, stripTrailingSlash?: boolean) => void;
                                                                            • Changes the request URI before the router begins processing the request where: Can only be called from an 'onRequest' extension method.

                                                                              Parameter url

                                                                              the new request URI. If url is a string, it is parsed with node's URL parse() method with parseQueryString set to true. url can also be set to an object compatible with node's URL parse() method output.

                                                                              Parameter stripTrailingSlash

                                                                              if true, strip the trailing slash from the path. Defaults to false. void [See docs](https://hapijs.com/api/17.0.1#-requestseturlurl-striptrailingslash)

                                                                            interface RequestApplicationState

                                                                            interface RequestApplicationState {}
                                                                            • User-extensible type for application specific state on requests (request.app).

                                                                            interface RequestAuth

                                                                            interface RequestAuth {}
                                                                            • Authentication information: * artifacts - an artifact object received from the authentication strategy and used in authentication-related actions. * credentials - the credential object received during the authentication process. The presence of an object does not mean successful authentication. * error - the authentication error is failed and mode set to 'try'. * isAuthenticated - true if the request has been successfully authenticated, otherwise false. * isAuthorized - true is the request has been successfully authorized against the route authentication access configuration. If the route has not access rules defined or if the request failed authorization, set to false. * mode - the route authentication mode. * strategy - the name of the strategy used. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-requestauth)

                                                                            property artifacts

                                                                            artifacts: AuthArtifacts;
                                                                            • an artifact object received from the authentication strategy and used in authentication-related actions.

                                                                            property credentials

                                                                            credentials: AuthCredentials;
                                                                            • the credential object received during the authentication process. The presence of an object does not mean successful authentication.

                                                                            property error

                                                                            error: Error;
                                                                            • the authentication error is failed and mode set to 'try'.

                                                                            property isAuthenticated

                                                                            isAuthenticated: boolean;
                                                                            • true if the request has been successfully authenticated, otherwise false.

                                                                            property isAuthorized

                                                                            isAuthorized: boolean;
                                                                            • true is the request has been successfully authorized against the route authentication access configuration. If the route has not access rules defined or if the request failed authorization, set to false.

                                                                            property mode

                                                                            mode: AuthMode;
                                                                            • the route authentication mode.

                                                                            property strategy

                                                                            strategy: string;
                                                                            • the name of the strategy used.

                                                                            interface RequestEvent

                                                                            interface RequestEvent {}

                                                                              property channel

                                                                              channel: 'internal' | 'app' | 'error';
                                                                              • set to 'internal' for internally generated events, otherwise 'app' for events generated by server.log()

                                                                              property data

                                                                              data: object;
                                                                              • event-specific information. Available when event data was provided and is not an error. Errors are passed via error.

                                                                              property error

                                                                              error: object;
                                                                              • the error object related to the event if applicable. Cannot appear together with data

                                                                              property tags

                                                                              tags: string[];
                                                                              • an array of tags identifying the event (e.g. ['error', 'http'])

                                                                              property timestamp

                                                                              timestamp: string;
                                                                              • the event timestamp.

                                                                              interface RequestEvents

                                                                              interface RequestEvents extends Podium {}
                                                                              • Access: read only and the public podium interface. The request.events supports the following events: * 'peek' - emitted for each chunk of payload data read from the client connection. The event method signature is function(chunk, encoding). * 'finish' - emitted when the request payload finished reading. The event method signature is function (). * 'disconnect' - emitted when a request errors or aborts unexpectedly. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-requestevents)

                                                                              method on

                                                                              on: {
                                                                              (criteria: 'peek', listener: PeekListener): this;
                                                                              (
                                                                              criteria: 'finish' | 'disconnect',
                                                                              listener: (data: undefined) => void
                                                                              ): this;
                                                                              };
                                                                              • Access: read only and the public podium interface. The request.events supports the following events: * 'peek' - emitted for each chunk of payload data read from the client connection. The event method signature is function(chunk, encoding). * 'finish' - emitted when the request payload finished reading. The event method signature is function (). * 'disconnect' - emitted when a request errors or aborts unexpectedly. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-requestevents)

                                                                              method once

                                                                              once: {
                                                                              (criteria: 'peek', listener: PeekListener): this;
                                                                              (criteria: 'peek'): Promise<[chunk: string, encoding: string]>;
                                                                              (
                                                                              criteria: 'finish' | 'disconnect',
                                                                              listener: (data: undefined) => void
                                                                              ): this;
                                                                              };
                                                                              • Access: read only and the public podium interface. The request.events supports the following events: * 'peek' - emitted for each chunk of payload data read from the client connection. The event method signature is function(chunk, encoding). * 'finish' - emitted when the request payload finished reading. The event method signature is function (). * 'disconnect' - emitted when a request errors or aborts unexpectedly. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-requestevents)

                                                                              interface RequestInfo

                                                                              interface RequestInfo {}
                                                                              • Request information: * acceptEncoding - the request preferred encoding. * cors - if CORS is enabled for the route, contains the following: * isOriginMatch - true if the request 'Origin' header matches the configured CORS restrictions. Set to false if no 'Origin' header is found or if it does not match. Note that this is only available after the 'onRequest' extension point as CORS is configured per-route and no routing decisions are made at that point in the request lifecycle. * host - content of the HTTP 'Host' header (e.g. 'example.com:8080'). * hostname - the hostname part of the 'Host' header (e.g. 'example.com'). * id - a unique request identifier (using the format '{now}:{connection.info.id}:{5 digits counter}'). * received - request reception timestamp. * referrer - content of the HTTP 'Referrer' (or 'Referer') header. * remoteAddress - remote client IP address. * remotePort - remote client port. * responded - request response timestamp (0 is not responded yet). Note that the request.info object is not meant to be modified. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-requestinfo)

                                                                              property acceptEncoding

                                                                              acceptEncoding: string;
                                                                              • the request preferred encoding.

                                                                              property completed

                                                                              completed: number;
                                                                              • request processing completion timestamp (0 is still processing).

                                                                              property cors

                                                                              cors: {
                                                                              /**
                                                                              * true if the request 'Origin' header matches the configured CORS restrictions. Set to false if no 'Origin' header is found or if it does not match. Note that this is only available after
                                                                              * the 'onRequest' extension point as CORS is configured per-route and no routing decisions are made at that point in the request lifecycle.
                                                                              */
                                                                              isOriginMatch?: boolean | undefined;
                                                                              };
                                                                              • if CORS is enabled for the route, contains the following:

                                                                              property host

                                                                              host: string;
                                                                              • content of the HTTP 'Host' header (e.g. 'example.com:8080').

                                                                              property hostname

                                                                              hostname: string;
                                                                              • the hostname part of the 'Host' header (e.g. 'example.com').

                                                                              property id

                                                                              id: string;
                                                                              • a unique request identifier (using the format '{now}:{connection.info.id}:{5 digits counter}')

                                                                              property received

                                                                              received: number;
                                                                              • request reception timestamp.

                                                                              property referrer

                                                                              referrer: string;
                                                                              • content of the HTTP 'Referrer' (or 'Referer') header.

                                                                              property remoteAddress

                                                                              remoteAddress: string;
                                                                              • remote client IP address.

                                                                              property remotePort

                                                                              remotePort: string;
                                                                              • remote client port.

                                                                              property responded

                                                                              responded: number;
                                                                              • request response timestamp (0 is not responded yet).

                                                                              interface RequestLog

                                                                              interface RequestLog {}

                                                                                property channel

                                                                                channel: string;

                                                                                  property data

                                                                                  data: string | object;

                                                                                    property request

                                                                                    request: string;

                                                                                      property tags

                                                                                      tags: string[];

                                                                                        property timestamp

                                                                                        timestamp: number;

                                                                                          interface RequestOrig

                                                                                          interface RequestOrig {}
                                                                                          • An object containing the values of params, query, and payload before any validation modifications made. Only set when input validation is performed. For context [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-requestorig)

                                                                                          property params

                                                                                          params: object;

                                                                                            property payload

                                                                                            payload: object;

                                                                                              property query

                                                                                              query: object;

                                                                                                interface RequestQuery

                                                                                                interface RequestQuery {}

                                                                                                  index signature

                                                                                                  [key: string]: any;

                                                                                                    interface RequestRoute

                                                                                                    interface RequestRoute {}
                                                                                                    • The request route information object, where: * method - the route HTTP method. * path - the route path. * vhost - the route vhost option if configured. * realm - the active realm associated with the route. * settings - the route options object with all defaults applied. * fingerprint - the route internal normalized string representing the normalized path. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-requestroute)

                                                                                                    property auth

                                                                                                    auth: {
                                                                                                    /**
                                                                                                    * Validates a request against the route's authentication access configuration, where:
                                                                                                    * @param request - the request object.
                                                                                                    * @return Return value: true if the request would have passed the route's access requirements.
                                                                                                    * Note that the route's authentication mode and strategies are ignored. The only match is made between the request.auth.credentials scope and entity information and the route access
                                                                                                    * configuration. If the route uses dynamic scopes, the scopes are constructed against the request.query, request.params, request.payload, and request.auth.credentials which may or may
                                                                                                    * not match between the route and the request's route. If this method is called using a request that has not been authenticated (yet or not at all), it will return false if the route
                                                                                                    * requires any authentication.
                                                                                                    * [See docs](https://hapijs.com/api/17.0.1#-requestrouteauthaccessrequest)
                                                                                                    */
                                                                                                    access(request: Request): boolean;
                                                                                                    };

                                                                                                      property fingerprint

                                                                                                      fingerprint: string;
                                                                                                      • the route internal normalized string representing the normalized path.

                                                                                                      property method

                                                                                                      method: Util.HTTP_METHODS_PARTIAL;
                                                                                                      • the route HTTP method.

                                                                                                      property path

                                                                                                      path: string;
                                                                                                      • the route path.

                                                                                                      property realm

                                                                                                      realm: ServerRealm;
                                                                                                      • the active realm associated with the route.

                                                                                                      property settings

                                                                                                      settings: RouteSettings;
                                                                                                      • the route options object with all defaults applied.

                                                                                                      property vhost

                                                                                                      vhost?: string | string[] | undefined;
                                                                                                      • the route vhost option if configured.

                                                                                                      interface ResponseApplicationState

                                                                                                      interface ResponseApplicationState {}
                                                                                                      • User-extensible type for application specific state on responses (response.app).

                                                                                                      interface ResponseEvents

                                                                                                      interface ResponseEvents extends Podium {}
                                                                                                      • Access: read only and the public podium interface. The response.events object supports the following events: * 'peek' - emitted for each chunk of data written back to the client connection. The event method signature is function(chunk, encoding). * 'finish' - emitted when the response finished writing but before the client response connection is ended. The event method signature is function (). [See docs](https://hapijs.com/api/17.0.1#-responseevents)

                                                                                                      method on

                                                                                                      on: {
                                                                                                      (criteria: 'peek', listener: PeekListener): this;
                                                                                                      (criteria: 'finish', listener: (data: undefined) => void): this;
                                                                                                      };
                                                                                                      • 'peek' - emitted for each chunk of data written back to the client connection. The event method signature is function(chunk, encoding). 'finish' - emitted when the response finished writing but before the client response connection is ended. The event method signature is function ().

                                                                                                      method once

                                                                                                      once: {
                                                                                                      (criteria: 'peek', listener: PeekListener): this;
                                                                                                      (criteria: 'peek'): Promise<[chunk: string, encoding: string]>;
                                                                                                      (criteria: 'finish', listener: (data: undefined) => void): this;
                                                                                                      };
                                                                                                      • 'peek' - emitted for each chunk of data written back to the client connection. The event method signature is function(chunk, encoding). 'finish' - emitted when the response finished writing but before the client response connection is ended. The event method signature is function ().

                                                                                                      interface ResponseObject

                                                                                                      interface ResponseObject extends Podium {}
                                                                                                      • The response object contains the request response value along with various HTTP headers and flags. When a lifecycle method returns a value, the value is wrapped in a response object along with some default flags (e.g. 200 status code). In order to customize a response before it is returned, the h.response() method is provided. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#response-object) TODO, check extending from Podium is correct. Extending because of "The response object supports the following events" [See docs](https://hapijs.com/api/17.0.1#-responseevents)

                                                                                                      property app

                                                                                                      app: ResponseApplicationState;
                                                                                                      • {}. Application-specific state. Provides a safe place to store application data without potential conflicts with the framework. Should not be used by plugins which should use plugins[name]. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responseapp)

                                                                                                      property events

                                                                                                      readonly events: ResponseEvents;
                                                                                                      • Access: read only and the public podium interface. The response.events object supports the following events: * 'peek' - emitted for each chunk of data written back to the client connection. The event method signature is function(chunk, encoding). * 'finish' - emitted when the response finished writing but before the client response connection is ended. The event method signature is function (). [See docs](https://hapijs.com/api/17.0.1#-responseevents)

                                                                                                      property headers

                                                                                                      readonly headers: Util.Dictionary<string | string[]>;
                                                                                                      • {}. An object containing the response headers where each key is a header field name and the value is the string header value or array of string. Note that this is an incomplete list of headers to be included with the response. Additional headers will be added once the response is prepared for transmission. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responseheaders)

                                                                                                      property plugins

                                                                                                      plugins: PluginsStates;
                                                                                                      • {}. Plugin-specific state. Provides a place to store and pass request-level plugin data. plugins is an object where each key is a plugin name and the value is the state. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responseplugins)

                                                                                                      property settings

                                                                                                      readonly settings: ResponseSettings;
                                                                                                      • Object containing the response handling flags. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responsesettings)

                                                                                                      property source

                                                                                                      readonly source: Lifecycle.ReturnValue;
                                                                                                      • The raw value returned by the lifecycle method. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responsesource)

                                                                                                      property statusCode

                                                                                                      readonly statusCode: number;
                                                                                                      • 200. The HTTP response status code. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responsestatuscode)

                                                                                                      property variety

                                                                                                      readonly variety: 'plain' | 'buffer' | 'stream';
                                                                                                      • A string indicating the type of source with available values: * 'plain' - a plain response such as string, number, null, or simple object. * 'buffer' - a Buffer. * 'stream' - a Stream. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responsevariety)

                                                                                                      method bytes

                                                                                                      bytes: (length: number) => ResponseObject;
                                                                                                      • Sets the HTTP 'Content-Length' header (to avoid chunked transfer encoding) where:

                                                                                                        Parameter length

                                                                                                        the header value. Must match the actual payload size. Return value: the current response object. [See docs](https://hapijs.com/api/17.0.1#-responsebyteslength)

                                                                                                      method charset

                                                                                                      charset: (charset?: string) => ResponseObject;
                                                                                                      • Controls the 'Content-Type' HTTP header 'charset' property of the response. * When invoked without any parameter, will prevent hapijs from applying its default charset normalization to 'utf-8' * When 'charset' parameter is provided, will set the 'Content-Type' HTTP header 'charset' property where:

                                                                                                        Parameter charset

                                                                                                        the charset property value. Return value: the current response object. [See docs](https://hapijs.com/api/17.0.1#-responsecharsetcharset)

                                                                                                      method code

                                                                                                      code: (statusCode: number) => ResponseObject;
                                                                                                      • Sets the HTTP status code where:

                                                                                                        Parameter statusCode

                                                                                                        the HTTP status code (e.g. 200). Return value: the current response object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responsecodestatuscode)

                                                                                                      method created

                                                                                                      created: (uri: string) => ResponseObject;
                                                                                                      • Sets the HTTP status code to Created (201) and the HTTP 'Location' header where:

                                                                                                        Parameter uri

                                                                                                        an absolute or relative URI used as the 'Location' header value. Return value: the current response object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responsecreateduri)

                                                                                                      method encoding

                                                                                                      encoding: (
                                                                                                      encoding:
                                                                                                      | 'ascii'
                                                                                                      | 'utf8'
                                                                                                      | 'utf16le'
                                                                                                      | 'ucs2'
                                                                                                      | 'base64'
                                                                                                      | 'latin1'
                                                                                                      | 'binary'
                                                                                                      | 'hex'
                                                                                                      ) => ResponseObject;
                                                                                                      • Sets the string encoding scheme used to serial data into the HTTP payload where:

                                                                                                        Parameter encoding

                                                                                                        the encoding property value (see node Buffer encoding [See docs](https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings)). * 'ascii' - for 7-bit ASCII data only. This encoding is fast and will strip the high bit if set. * 'utf8' - Multibyte encoded Unicode characters. Many web pages and other document formats use UTF-8. * 'utf16le' - 2 or 4 bytes, little-endian encoded Unicode characters. Surrogate pairs (U+10000 to U+10FFFF) are supported. * 'ucs2' - Alias of 'utf16le'. * 'base64' - Base64 encoding. When creating a Buffer from a string, this encoding will also correctly accept "URL and Filename Safe Alphabet" as specified in RFC4648, Section 5. * 'latin1' - A way of encoding the Buffer into a one-byte encoded string (as defined by the IANA in RFC1345, page 63, to be the Latin-1 supplement block and C0/C1 control codes). * 'binary' - Alias for 'latin1'. * 'hex' - Encode each byte as two hexadecimal characters. Return value: the current response object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responseencodingencoding)

                                                                                                      method etag

                                                                                                      etag: (
                                                                                                      tag: string,
                                                                                                      options?: { weak: boolean; vary: boolean }
                                                                                                      ) => ResponseObject;
                                                                                                      • Sets the representation entity tag where:

                                                                                                        Parameter tag

                                                                                                        the entity tag string without the double-quote.

                                                                                                        Parameter options

                                                                                                        (optional) settings where: * weak - if true, the tag will be prefixed with the 'W/' weak signifier. Weak tags will fail to match identical tags for the purpose of determining 304 response status. Defaults to false. * vary - if true and content encoding is set or applied to the response (e.g 'gzip' or 'deflate'), the encoding name will be automatically added to the tag at transmission time (separated by a '-' character). Ignored when weak is true. Defaults to true. Return value: the current response object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responseetagtag-options)

                                                                                                      method header

                                                                                                      header: (
                                                                                                      name: string,
                                                                                                      value: string,
                                                                                                      options?: ResponseObjectHeaderOptions
                                                                                                      ) => ResponseObject;
                                                                                                      • Sets an HTTP header where:

                                                                                                        Parameter name

                                                                                                        the header name.

                                                                                                        Parameter value

                                                                                                        the header value.

                                                                                                        Parameter options

                                                                                                        (optional) object where: * append - if true, the value is appended to any existing header value using separator. Defaults to false. * separator - string used as separator when appending to an existing value. Defaults to ','. * override - if false, the header value is not set if an existing value present. Defaults to true. * duplicate - if false, the header value is not modified if the provided value is already included. Does not apply when append is false or if the name is 'set-cookie'. Defaults to true. Return value: the current response object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responseheadername-value-options)

                                                                                                      method location

                                                                                                      location: (uri: string) => ResponseObject;
                                                                                                      • Sets the HTTP 'Location' header where:

                                                                                                        Parameter uri

                                                                                                        an absolute or relative URI used as the 'Location' header value. Return value: the current response object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responselocationuri)

                                                                                                      method message

                                                                                                      message: (httpMessage: string) => ResponseObject;
                                                                                                      • Sets the HTTP status message where:

                                                                                                        Parameter httpMessage

                                                                                                        the HTTP status message (e.g. 'Ok' for status code 200). Return value: the current response object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responsemessagehttpmessage)

                                                                                                      method permanent

                                                                                                      permanent: (isPermanent: boolean) => ResponseObject;
                                                                                                      • Sets the status code to 301 or 308 (based on the response.rewritable() setting) where:

                                                                                                        Parameter isPermanent

                                                                                                        if false, sets status to temporary. Defaults to true. Return value: the current response object. Only available after calling the response.redirect() method. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responsepermanentispermanent)

                                                                                                      method redirect

                                                                                                      redirect: (uri: string) => ResponseObject;
                                                                                                      • Sets an HTTP redirection response (302) and decorates the response with additional methods, where:

                                                                                                        Parameter uri

                                                                                                        an absolute or relative URI used to redirect the client to another resource. Return value: the current response object. Decorates the response object with the response.temporary(), response.permanent(), and response.rewritable() methods to easily change the default redirection code (302). [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responseredirecturi)

                                                                                                      method replacer

                                                                                                      replacer: (method: Json.StringifyReplacer) => ResponseObject;
                                                                                                      • Sets the JSON.stringify() replacer argument where:

                                                                                                        Parameter method

                                                                                                        the replacer function or array. Defaults to none. Return value: the current response object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responsereplacermethod)

                                                                                                      method rewritable

                                                                                                      rewritable: (isRewritable: boolean) => ResponseObject;
                                                                                                      • Sets the status code to 301/302 for rewritable (allows changing the request method from 'POST' to 'GET') or 307/308 for non-rewritable (does not allow changing the request method from 'POST' to 'GET'). Exact code based on the response.temporary() or response.permanent() setting. Arguments:

                                                                                                        Parameter isRewritable

                                                                                                        if false, sets to non-rewritable. Defaults to true. Return value: the current response object. Only available after calling the response.redirect() method. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responserewritableisrewritable)

                                                                                                      method spaces

                                                                                                      spaces: (count: number) => ResponseObject;
                                                                                                      • Sets the JSON.stringify() space argument where:

                                                                                                        Parameter count

                                                                                                        the number of spaces to indent nested object keys. Defaults to no indentation. Return value: the current response object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responsespacescount)

                                                                                                      method state

                                                                                                      state: (
                                                                                                      name: string,
                                                                                                      value: object | string,
                                                                                                      options?: ServerStateCookieOptions
                                                                                                      ) => ResponseObject;
                                                                                                      • Sets an HTTP cookie where:

                                                                                                        Parameter name

                                                                                                        the cookie name.

                                                                                                        Parameter value

                                                                                                        the cookie value. If no options.encoding is defined, must be a string. See server.state() for supported encoding values.

                                                                                                        Parameter options

                                                                                                        (optional) configuration. If the state was previously registered with the server using server.state(), the specified keys in options are merged with the default server definition. Return value: the current response object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responsestatename-value-options)

                                                                                                      method suffix

                                                                                                      suffix: (suffix: string) => ResponseObject;
                                                                                                      • Sets a string suffix when the response is process via JSON.stringify() where:

                                                                                                        Parameter suffix

                                                                                                        the string suffix. Return value: the current response object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responsesuffixsuffix)

                                                                                                      method takeover

                                                                                                      takeover: () => ResponseObject;
                                                                                                      • Marks the response object as a takeover response. Return value: the current response object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responsetakeover)

                                                                                                      method temporary

                                                                                                      temporary: (isTemporary: boolean) => ResponseObject;
                                                                                                      • Sets the status code to 302 or 307 (based on the response.rewritable() setting) where:

                                                                                                        Parameter isTemporary

                                                                                                        if false, sets status to permanent. Defaults to true. Return value: the current response object. Only available after calling the response.redirect() method. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responsetemporaryistemporary)

                                                                                                      method ttl

                                                                                                      ttl: (msec: number) => ResponseObject;
                                                                                                      • Overrides the default route cache expiration rule for this response instance where:

                                                                                                        Parameter msec

                                                                                                        the time-to-live value in milliseconds. Return value: the current response object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responsettlmsec)

                                                                                                      method type

                                                                                                      type: (mimeType: string) => ResponseObject;
                                                                                                      • Sets the HTTP 'Content-Type' header where:

                                                                                                        Parameter mimeType

                                                                                                        is the mime type. Return value: the current response object. Should only be used to override the built-in default for each response type. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responsetypemimetype)

                                                                                                      method unstate

                                                                                                      unstate: (name: string, options?: ServerStateCookieOptions) => ResponseObject;
                                                                                                      • Clears the HTTP cookie by setting an expired value where:

                                                                                                        Parameter name

                                                                                                        the cookie name.

                                                                                                        Parameter options

                                                                                                        (optional) configuration for expiring cookie. If the state was previously registered with the server using server.state(), the specified options are merged with the server definition. Return value: the current response object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responseunstatename-options)

                                                                                                      method vary

                                                                                                      vary: (header: string) => ResponseObject;
                                                                                                      • Adds the provided header to the list of inputs affected the response generation via the HTTP 'Vary' header where:

                                                                                                        Parameter header

                                                                                                        the HTTP request header name. Return value: the current response object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responsevaryheader)

                                                                                                      interface ResponseObjectHeaderOptions

                                                                                                      interface ResponseObjectHeaderOptions {}
                                                                                                      • Object where: * append - if true, the value is appended to any existing header value using separator. Defaults to false. * separator - string used as separator when appending to an existing value. Defaults to ','. * override - if false, the header value is not set if an existing value present. Defaults to true. * duplicate - if false, the header value is not modified if the provided value is already included. Does not apply when append is false or if the name is 'set-cookie'. Defaults to true. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responseheadername-value-options) [See docs](https://github.com/hapijs/hapi/blob/master/API.md#response-object)

                                                                                                      property append

                                                                                                      append?: boolean | undefined;

                                                                                                        property duplicate

                                                                                                        duplicate?: boolean | undefined;

                                                                                                          property override

                                                                                                          override?: boolean | undefined;

                                                                                                            property separator

                                                                                                            separator?: string | undefined;

                                                                                                              interface ResponseSettings

                                                                                                              interface ResponseSettings {}
                                                                                                              • Object containing the response handling flags. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-responsesettings)

                                                                                                              property passThrough

                                                                                                              readonly passThrough: boolean;
                                                                                                              • Defaults value: true. If true and source is a Stream, copies the statusCode and headers properties of the stream object to the outbound response.

                                                                                                              property stringify

                                                                                                              readonly stringify: Json.StringifyArguments;
                                                                                                              • null (use route defaults). Override the route json options used when source value requires stringification.

                                                                                                              property ttl

                                                                                                              readonly ttl: number;
                                                                                                              • null (use route defaults). If set, overrides the route cache with an expiration value in milliseconds.

                                                                                                              property varyEtag

                                                                                                              varyEtag: boolean;
                                                                                                              • false. If true, a suffix will be automatically added to the 'ETag' header at transmission time (separated by a '-' character) when the HTTP 'Vary' header is present.

                                                                                                              interface ResponseToolkit

                                                                                                              interface ResponseToolkit {}
                                                                                                              • The response toolkit is a collection of properties and utilities passed to every [lifecycle method](https://github.com/hapijs/hapi/blob/master/API.md#lifecycle-methods) It is somewhat hard to define as it provides both utilities for manipulating responses as well as other information. Since the toolkit is passed as a function argument, developers can name it whatever they want. For the purpose of this document the h notation is used. It is named in the spirit of the RethinkDB r method, with h for hapi. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#response-toolkit)

                                                                                                              property abandon

                                                                                                              readonly abandon: symbol;
                                                                                                              • A response symbol. When returned by a lifecycle method, the request lifecycle skips to the finalizing step without further interaction with the node response stream. It is the developer's responsibility to write and end the response directly via [request.raw.res](https://github.com/hapijs/hapi/blob/master/API.md#request.raw).

                                                                                                              property close

                                                                                                              readonly close: symbol;
                                                                                                              • A response symbol. When returned by a lifecycle method, the request lifecycle skips to the finalizing step after calling request.raw.res.end()) to close the the node response stream.

                                                                                                              property context

                                                                                                              readonly context: any;
                                                                                                              • A response symbol. Provides access to the route or server context set via the route [bind](https://github.com/hapijs/hapi/blob/master/API.md#route.options.bind) option or [server.bind()](https://github.com/hapijs/hapi/blob/master/API.md#server.bind()).

                                                                                                              property continue

                                                                                                              readonly continue: symbol;
                                                                                                              • A response symbol. When returned by a lifecycle method, the request lifecycle continues without changing the response.

                                                                                                              property realm

                                                                                                              readonly realm: ServerRealm;
                                                                                                              • The [server realm](https://github.com/hapijs/hapi/blob/master/API.md#server.realm) associated with the matching route. Defaults to the root server realm in the onRequest step.

                                                                                                              property request

                                                                                                              readonly request: Readonly<Request>;
                                                                                                              • Access: read only and public request interface. The [request] object. This is a duplication of the request lifecycle method argument used by [toolkit decorations](https://github.com/hapijs/hapi/blob/master/API.md#server.decorate()) to access the current request.

                                                                                                              method authenticated

                                                                                                              authenticated: (data: AuthenticationData) => Auth;
                                                                                                              • Used by the [authentication] method to pass back valid credentials where:

                                                                                                                Parameter data

                                                                                                                an object with: * credentials - (required) object representing the authenticated entity. * artifacts - (optional) authentication artifacts object specific to the authentication scheme. Return value: an internal authentication object.

                                                                                                              method entity

                                                                                                              entity: (options?: {
                                                                                                              etag?: string | undefined;
                                                                                                              modified?: string | undefined;
                                                                                                              vary?: boolean | undefined;
                                                                                                              }) => ResponseObject | undefined;
                                                                                                              • Sets the response 'ETag' and 'Last-Modified' headers and checks for any conditional request headers to decide if the response is going to qualify for an HTTP 304 (Not Modified). If the entity values match the request conditions, h.entity() returns a response object for the lifecycle method to return as its value which will set a 304 response. Otherwise, it sets the provided entity headers and returns undefined. The method argumetns are:

                                                                                                                Parameter options

                                                                                                                a required configuration object with: * etag - the ETag string. Required if modified is not present. Defaults to no header. * modified - the Last-Modified header value. Required if etag is not present. Defaults to no header. * vary - same as the response.etag() option. Defaults to true. Return value: - a response object if the response is unmodified. - undefined if the response has changed. If undefined is returned, the developer must return a valid lifecycle method value. If a response is returned, it should be used as the return value (but may be customize using the response methods). [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-hentityoptions)

                                                                                                              method redirect

                                                                                                              redirect: (uri?: string) => ResponseObject;
                                                                                                              • Redirects the client to the specified uri. Same as calling h.response().redirect(uri).

                                                                                                                Parameter url

                                                                                                                Returns a response object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-hredirecturi)

                                                                                                              method response

                                                                                                              response: (value?: ResponseValue) => ResponseObject;
                                                                                                              • Wraps the provided value and returns a response object which allows customizing the response (e.g. setting the HTTP status code, custom headers, etc.), where:

                                                                                                                Parameter value

                                                                                                                (optional) return value. Defaults to null. Returns a response object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-hresponsevalue)

                                                                                                              method state

                                                                                                              state: (
                                                                                                              name: string,
                                                                                                              value: string | object,
                                                                                                              options?: ServerStateCookieOptions
                                                                                                              ) => void;
                                                                                                              • Sets a response cookie using the same arguments as response.state().

                                                                                                                Parameter name

                                                                                                                of the cookie

                                                                                                                Parameter value

                                                                                                                of the cookie

                                                                                                                Parameter

                                                                                                                (optional) ServerStateCookieOptions object. Return value: none. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-hstatename-value-options)

                                                                                                              method unauthenticated

                                                                                                              unauthenticated: (error: Error, data?: AuthenticationData) => Auth;
                                                                                                              • Used by the [authentication] method to indicate authentication failed and pass back the credentials received where:

                                                                                                                Parameter error

                                                                                                                (required) the authentication error.

                                                                                                                Parameter data

                                                                                                                (optional) an object with: * credentials - (required) object representing the authenticated entity. * artifacts - (optional) authentication artifacts object specific to the authentication scheme. void. The method is used to pass both the authentication error and the credentials. For example, if a request included expired credentials, it allows the method to pass back the user information (combined with a 'try' authentication mode) for error customization. There is no difference between throwing the error or passing it with the h.unauthenticated() method is no credentials are passed, but it might still be helpful for code clarity. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-hunauthenticatederror-data)

                                                                                                              method unstate

                                                                                                              unstate: (name: string, options?: ServerStateCookieOptions) => void;
                                                                                                              • Clears a response cookie using the same arguments as

                                                                                                                Parameter name

                                                                                                                of the cookie

                                                                                                                Parameter options

                                                                                                                (optional) ServerStateCookieOptions object. void. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-hunstatename-options)

                                                                                                              interface RouteExtObject

                                                                                                              interface RouteExtObject {}

                                                                                                                property method

                                                                                                                method: Lifecycle.Method;

                                                                                                                  property options

                                                                                                                  options?: ServerExtOptions | undefined;

                                                                                                                    interface RouteOptions

                                                                                                                    interface RouteOptions extends CommonRouteProperties {}
                                                                                                                    • Each route can be customized to change the default behavior of the request lifecycle. For context [See docs](https://github.com/hapijs/hapi/blob/master/API.md#route-options)

                                                                                                                    property auth

                                                                                                                    auth?: false | string | RouteOptionsAccess | undefined;
                                                                                                                    • Route authentication configuration. Value can be: false to disable authentication if a default strategy is set. a string with the name of an authentication strategy registered with server.auth.strategy(). The strategy will be set to 'required' mode. an authentication configuration object. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsapp)

                                                                                                                    interface RouteOptionsAccess

                                                                                                                    interface RouteOptionsAccess {}
                                                                                                                    • Route Authentication Options

                                                                                                                    property access

                                                                                                                    access?: RouteOptionsAccessObject | RouteOptionsAccessObject[] | undefined;
                                                                                                                    • none. An object or array of objects specifying the route access rules. Each rule is evaluated against an incoming request and access is granted if at least one of the rules matches. Each rule object must include at least one of scope or entity. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsauthaccess)

                                                                                                                    property entity

                                                                                                                    entity?: AccessEntity | undefined;
                                                                                                                    • 'any'. The required authenticated entity type. If set, must match the entity value of the request authenticated credentials. Available values: * 'any' - the authentication can be on behalf of a user or application. * 'user' - the authentication must be on behalf of a user which is identified by the presence of a 'user' attribute in the credentials object returned by the authentication strategy. * 'app' - the authentication must be on behalf of an application which is identified by the lack of presence of a user attribute in the credentials object returned by the authentication strategy. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsauthaccessentity)

                                                                                                                    property mode

                                                                                                                    mode?: AuthMode | undefined;
                                                                                                                    • 'required'. The authentication mode. Available values: * 'required' - authentication is required. * 'optional' - authentication is optional - the request must include valid credentials or no credentials at all. * 'try' - similar to 'optional', any request credentials are attempted authentication, but if the credentials are invalid, the request proceeds regardless of the authentication error. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsauthmode)

                                                                                                                    property payload

                                                                                                                    payload?: false | 'required' | 'optional' | undefined;
                                                                                                                    • false, unless the scheme requires payload authentication. If set, the incoming request payload is authenticated after it is processed. Requires a strategy with payload authentication support (e.g. Hawk). Cannot be set to a value other than 'required' when the scheme sets the authentication options.payload to true. Available values: * false - no payload authentication. * 'required' - payload authentication required. * 'optional' - payload authentication performed only when the client includes payload authentication information (e.g. hash attribute in Hawk). [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsauthpayload)

                                                                                                                    property scope

                                                                                                                    scope?: RouteOptionsAccessScope | undefined;
                                                                                                                    • false (no scope requirements). The application scope required to access the route. Value can be a scope string or an array of scope strings. When authenticated, the credentials object scope property must contain at least one of the scopes defined to access the route. If a scope string begins with a + character, that scope is required. If a scope string begins with a ! character, that scope is forbidden. For example, the scope ['!a', '+b', 'c', 'd'] means the incoming request credentials' scope must not include 'a', must include 'b', and must include one of 'c' or 'd'. You may also access properties on the request object (query, params, payload, and credentials) to populate a dynamic scope by using the '{' and '}' characters around the property name, such as 'user-{params.id}'. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsauthaccessscope)

                                                                                                                    property strategies

                                                                                                                    strategies?: string[] | undefined;
                                                                                                                    • the default strategy set via server.auth.default(). An array of string strategy names in the order they should be attempted. Cannot be used together with strategy. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsauthstrategies)

                                                                                                                    property strategy

                                                                                                                    strategy?: string | undefined;
                                                                                                                    • the default strategy set via server.auth.default(). A string strategy names. Cannot be used together with strategies. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsauthstrategy)

                                                                                                                    interface RouteOptionsAccessEntityObject

                                                                                                                    interface RouteOptionsAccessEntityObject {}

                                                                                                                      property entity

                                                                                                                      entity: AccessEntity;

                                                                                                                        interface RouteOptionsAccessScopeObject

                                                                                                                        interface RouteOptionsAccessScopeObject {}

                                                                                                                          property scope

                                                                                                                          scope: RouteOptionsAccessScope;

                                                                                                                            interface RouteOptionsApp

                                                                                                                            interface RouteOptionsApp {}
                                                                                                                            • Empty interface to allow for user-defined augmentations.

                                                                                                                            interface RouteOptionsCors

                                                                                                                            interface RouteOptionsCors {}
                                                                                                                            • false (no CORS headers). The Cross-Origin Resource Sharing protocol allows browsers to make cross-origin API calls. CORS is required by web applications running inside a browser which are loaded from a different domain than the API server. To enable, set cors to true, or to an object with the following options: * origin - an array of allowed origin servers strings ('Access-Control-Allow-Origin'). The array can contain any combination of fully qualified origins along with origin strings containing a wildcard '*' character, or a single '*' origin string. If set to 'ignore', any incoming Origin header is ignored (present or not) and the 'Access-Control-Allow-Origin' header is set to '*'. Defaults to any origin ['*']. * maxAge - number of seconds the browser should cache the CORS response ('Access-Control-Max-Age'). The greater the value, the longer it will take before the browser checks for changes in policy. Defaults to 86400 (one day). * headers - a strings array of allowed headers ('Access-Control-Allow-Headers'). Defaults to ['Accept', 'Authorization', 'Content-Type', 'If-None-Match']. * additionalHeaders - a strings array of additional headers to headers. Use this to keep the default headers in place. * exposedHeaders - a strings array of exposed headers ('Access-Control-Expose-Headers'). Defaults to ['WWW-Authenticate', 'Server-Authorization']. * additionalExposedHeaders - a strings array of additional headers to exposedHeaders. Use this to keep the default headers in place. * credentials - if true, allows user credentials to be sent ('Access-Control-Allow-Credentials'). Defaults to false. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionscors)

                                                                                                                            property additionalExposedHeaders

                                                                                                                            additionalExposedHeaders?: string[] | undefined;
                                                                                                                            • a strings array of additional headers to exposedHeaders. Use this to keep the default headers in place.

                                                                                                                            property additionalHeaders

                                                                                                                            additionalHeaders?: string[] | undefined;
                                                                                                                            • a strings array of additional headers to headers. Use this to keep the default headers in place.

                                                                                                                            property credentials

                                                                                                                            credentials?: boolean | undefined;
                                                                                                                            • if true, allows user credentials to be sent ('Access-Control-Allow-Credentials'). Defaults to false.

                                                                                                                            property exposedHeaders

                                                                                                                            exposedHeaders?: string[] | undefined;
                                                                                                                            • a strings array of exposed headers ('Access-Control-Expose-Headers'). Defaults to ['WWW-Authenticate', 'Server-Authorization'].

                                                                                                                            property headers

                                                                                                                            headers?: string[] | undefined;
                                                                                                                            • a strings array of allowed headers ('Access-Control-Allow-Headers'). Defaults to ['Accept', 'Authorization', 'Content-Type', 'If-None-Match'].

                                                                                                                            property maxAge

                                                                                                                            maxAge?: number | undefined;
                                                                                                                            • number of seconds the browser should cache the CORS response ('Access-Control-Max-Age'). The greater the value, the longer it will take before the browser checks for changes in policy. Defaults to 86400 (one day).

                                                                                                                            property origin

                                                                                                                            origin?: string[] | '*' | 'ignore' | undefined;
                                                                                                                            • an array of allowed origin servers strings ('Access-Control-Allow-Origin'). The array can contain any combination of fully qualified origins along with origin strings containing a wildcard '*' character, or a single '*' origin string. If set to 'ignore', any incoming Origin header is ignored (present or not) and the 'Access-Control-Allow-Origin' header is set to '*'. Defaults to any origin ['*'].

                                                                                                                            interface RouteOptionsPayload

                                                                                                                            interface RouteOptionsPayload {}
                                                                                                                            • Determines how the request payload is processed. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionspayload)

                                                                                                                            property allow

                                                                                                                            allow?: string | string[] | undefined;
                                                                                                                            • allows parsing of the following mime types: * application/json * application/*+json * application/octet-stream * application/x-www-form-urlencoded * multipart/form-data * text/* A string or an array of strings with the allowed mime types for the endpoint. Use this settings to limit the set of allowed mime types. Note that allowing additional mime types not listed above will not enable them to be parsed, and if parse is true, the request will result in an error response. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionspayloadallow)

                                                                                                                            property compression

                                                                                                                            compression?: Util.Dictionary<PayloadCompressionDecoderSettings> | undefined;
                                                                                                                            • none. An object where each key is a content-encoding name and each value is an object with the desired decoder settings. Note that encoder settings are set in compression. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionspayloadcompression)

                                                                                                                            property defaultContentType

                                                                                                                            defaultContentType?: string | undefined;
                                                                                                                            • 'application/json'. The default content type if the 'Content-Type' request header is missing. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionspayloaddefaultcontenttype)

                                                                                                                            property failAction

                                                                                                                            failAction?: Lifecycle.FailAction | undefined;
                                                                                                                            • 'error' (return a Bad Request (400) error response). A failAction value which determines how to handle payload parsing errors. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionspayloadfailaction)

                                                                                                                            property maxBytes

                                                                                                                            maxBytes?: number | undefined;
                                                                                                                            • 1048576 (1MB). Limits the size of incoming payloads to the specified byte count. Allowing very large payloads may cause the server to run out of memory. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionspayloadmaxbytes)

                                                                                                                            property multipart

                                                                                                                            multipart?:
                                                                                                                            | false
                                                                                                                            | {
                                                                                                                            output: PayloadOutput | 'annotated';
                                                                                                                            }
                                                                                                                            | undefined;
                                                                                                                            • none. Overrides payload processing for multipart requests. Value can be one of: * false - disable multipart processing. an object with the following required options: * output - same as the output option with an additional value option: * * annotated - wraps each multipart part in an object with the following keys: // TODO type this? * * * headers - the part headers. * * * filename - the part file name. * * * payload - the processed part payload. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionspayloadmultipart)

                                                                                                                            property output

                                                                                                                            output?: PayloadOutput | undefined;
                                                                                                                            • 'data'. The processed payload format. The value must be one of: * 'data' - the incoming payload is read fully into memory. If parse is true, the payload is parsed (JSON, form-decoded, multipart) based on the 'Content-Type' header. If parse is false, a raw Buffer is returned. * 'stream' - the incoming payload is made available via a Stream.Readable interface. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files are provided as streams. File streams from a 'multipart/form-data' upload will also have a hapi property containing the filename and headers properties. Note that payload streams for multipart payloads are a synthetic interface created on top of the entire mutlipart content loaded into memory. To avoid loading large multipart payloads into memory, set parse to false and handle the multipart payload in the handler using a streaming parser (e.g. pez). * 'file' - the incoming payload is written to temporary file in the directory specified by the uploads settings. If the payload is 'multipart/form-data' and parse is true, field values are presented as text while files are saved to disk. Note that it is the sole responsibility of the application to clean up the files generated by the framework. This can be done by keeping track of which files are used (e.g. using the request.app object), and listening to the server 'response' event to perform cleanup. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionspayloadoutput)

                                                                                                                            property override

                                                                                                                            override?: string | undefined;
                                                                                                                            • none. A mime type string overriding the 'Content-Type' header value received. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionspayloadoverride)

                                                                                                                            property parse

                                                                                                                            parse?: boolean | 'gunzip' | undefined;
                                                                                                                            • true. Determines if the incoming payload is processed or presented raw. Available values: * true - if the request 'Content-Type' matches the allowed mime types set by allow (for the whole payload as well as parts), the payload is converted into an object when possible. If the format is unknown, a Bad Request (400) error response is sent. Any known content encoding is decoded. * false - the raw payload is returned unmodified. * 'gunzip' - the raw payload is returned unmodified after any known content encoding is decoded. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionspayloadparse)

                                                                                                                            property timeout

                                                                                                                            timeout?: false | number | undefined;
                                                                                                                            • to 10000 (10 seconds). Payload reception timeout in milliseconds. Sets the maximum time allowed for the client to transmit the request payload (body) before giving up and responding with a Request Timeout (408) error response. Set to false to disable. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionspayloadtimeout)

                                                                                                                            property uploads

                                                                                                                            uploads?: string | undefined;
                                                                                                                            • os.tmpdir(). The directory used for writing file uploads. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionspayloaduploads)

                                                                                                                            interface RouteOptionsPreObject

                                                                                                                            interface RouteOptionsPreObject {}
                                                                                                                            • An object with: * method - a lifecycle method. * assign - key name used to assign the response of the method to in request.pre and request.preResponses. * failAction - A failAction value which determine what to do when a pre-handler method throws an error. If assign is specified and the failAction setting is not 'error', the error will be assigned. For context [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionspre)

                                                                                                                            property assign

                                                                                                                            assign?: string | undefined;
                                                                                                                            • key name used to assign the response of the method to in request.pre and request.preResponses.

                                                                                                                            property failAction

                                                                                                                            failAction?: Lifecycle.FailAction | undefined;
                                                                                                                            • A failAction value which determine what to do when a pre-handler method throws an error. If assign is specified and the failAction setting is not 'error', the error will be assigned.

                                                                                                                            property method

                                                                                                                            method: Lifecycle.Method;
                                                                                                                            • a lifecycle method.

                                                                                                                            interface RouteOptionsResponse

                                                                                                                            interface RouteOptionsResponse {}
                                                                                                                            • Processing rules for the outgoing response. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsresponse)

                                                                                                                            property disconnectStatusCode

                                                                                                                            disconnectStatusCode?: number | undefined;
                                                                                                                            • The default HTTP status code used to set a response error when the request is closed or aborted before the response is fully transmitted. Value can be any integer greater or equal to 400. The default value 499 is based on the non-standard nginx "CLIENT CLOSED REQUEST" error. The value is only used for logging as the request has already ended. 499

                                                                                                                            property emptyStatusCode

                                                                                                                            emptyStatusCode?: 200 | 204 | undefined;
                                                                                                                            • 204. The default HTTP status code when the payload is considered empty. Value can be 200 or 204. Note that a 200 status code is converted to a 204 only at the time of response transmission (the response status code will remain 200 throughout the request lifecycle unless manually set). [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsresponseemptystatuscode)

                                                                                                                            property failAction

                                                                                                                            failAction?: Lifecycle.FailAction | undefined;
                                                                                                                            • 'error' (return an Internal Server Error (500) error response). A failAction value which defines what to do when a response fails payload validation. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsresponsefailaction)

                                                                                                                            property modify

                                                                                                                            modify?: boolean | undefined;
                                                                                                                            • false. If true, applies the validation rule changes to the response payload. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsresponsemodify)

                                                                                                                            property options

                                                                                                                            options?: ValidationOptions | undefined;
                                                                                                                            • none. [joi](https://github.com/hapijs/joi) options object pass to the validation function. Useful to set global options such as stripUnknown or abortEarly (the complete list is available here). If a custom validation function is defined via schema or status then options can an arbitrary object that will be passed to this function as the second argument. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsresponseoptions)

                                                                                                                            property ranges

                                                                                                                            ranges?: boolean | undefined;
                                                                                                                            • true. If false, payload range support is disabled. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsresponseranges)

                                                                                                                            property sample

                                                                                                                            sample?: number | undefined;
                                                                                                                            • 100 (all responses). The percent of response payloads validated (0 - 100). Set to 0 to disable all validation. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsresponsesample)

                                                                                                                            property schema

                                                                                                                            schema?: RouteOptionsResponseSchema | undefined;
                                                                                                                            • true (no validation). The default response payload validation rules (for all non-error responses) expressed as one of: * true - any payload allowed (no validation). * false - no payload allowed. * a joi validation object. The options along with the request context ({ headers, params, query, payload, app, auth }) are passed to the validation function. * a validation function using the signature async function(value, options) where: * * value - the pending response payload. * * options - The options along with the request context ({ headers, params, query, payload, app, auth }). * * if the function returns a value and modify is true, the value is used as the new response. If the original response is an error, the return value is used to override the original error output.payload. If an error is thrown, the error is processed according to failAction. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsresponseschema)

                                                                                                                            property status

                                                                                                                            status?: Util.Dictionary<RouteOptionsResponseSchema> | undefined;
                                                                                                                            • none. Validation schemas for specific HTTP status codes. Responses (excluding errors) not matching the listed status codes are validated using the default schema. status is set to an object where each key is a 3 digit HTTP status code and the value has the same definition as schema. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsresponsestatus)

                                                                                                                            interface RouteOptionsSecureObject

                                                                                                                            interface RouteOptionsSecureObject {}
                                                                                                                            • false (security headers disabled). Sets common security headers. To enable, set security to true or to an object with the following options: * hsts - controls the 'Strict-Transport-Security' header, where: * * true - the header will be set to max-age=15768000. This is the default value. * * a number - the maxAge parameter will be set to the provided value. * * an object with the following fields: * * * maxAge - the max-age portion of the header, as a number. Default is 15768000. * * * includeSubDomains - a boolean specifying whether to add the includeSubDomains flag to the header. * * * preload - a boolean specifying whether to add the 'preload' flag (used to submit domains inclusion in Chrome's HTTP Strict Transport Security (HSTS) preload list) to the header. * xframe - controls the 'X-Frame-Options' header, where: * * true - the header will be set to 'DENY'. This is the default value. * * 'deny' - the headers will be set to 'DENY'. * * 'sameorigin' - the headers will be set to 'SAMEORIGIN'. * * an object for specifying the 'allow-from' rule, where: * * * rule - one of: * * * * 'deny' * * * * 'sameorigin' * * * * 'allow-from' * * * source - when rule is 'allow-from' this is used to form the rest of the header, otherwise this field is ignored. If rule is 'allow-from' but source is unset, the rule will be automatically changed to 'sameorigin'. * xss - boolean that controls the 'X-XSS-PROTECTION' header for Internet Explorer. Defaults to true which sets the header to equal '1; mode=block'. Note: this setting can create a security vulnerability in versions of Internet Exploere below 8, as well as unpatched versions of IE8. See here and here for more information. If you actively support old versions of IE, it may be wise to explicitly set this flag to false. * noOpen - boolean controlling the 'X-Download-Options' header for Internet Explorer, preventing downloads from executing in your context. Defaults to true setting the header to 'noopen'. * noSniff - boolean controlling the 'X-Content-Type-Options' header. Defaults to true setting the header to its only and default option, 'nosniff'. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionssecurity)

                                                                                                                            property hsts

                                                                                                                            hsts?:
                                                                                                                            | boolean
                                                                                                                            | number
                                                                                                                            | {
                                                                                                                            /**
                                                                                                                            * the max-age portion of the header, as a number. Default is 15768000.
                                                                                                                            */
                                                                                                                            maxAge: number;
                                                                                                                            /**
                                                                                                                            * a boolean specifying whether to add the includeSubDomains flag to the header.
                                                                                                                            */
                                                                                                                            includeSubDomains: boolean;
                                                                                                                            /**
                                                                                                                            * a boolean specifying whether to add the 'preload' flag (used to submit domains inclusion in Chrome's HTTP Strict Transport Security (HSTS) preload list) to the header.
                                                                                                                            */
                                                                                                                            preload: boolean;
                                                                                                                            }
                                                                                                                            | undefined;
                                                                                                                            • hsts - controls the 'Strict-Transport-Security' header

                                                                                                                            property noOpen

                                                                                                                            noOpen?: boolean | undefined;
                                                                                                                            • boolean controlling the 'X-Download-Options' header for Internet Explorer, preventing downloads from executing in your context. Defaults to true setting the header to 'noopen'.

                                                                                                                            property noSniff

                                                                                                                            noSniff?: boolean | undefined;
                                                                                                                            • boolean controlling the 'X-Content-Type-Options' header. Defaults to true setting the header to its only and default option, 'nosniff'.

                                                                                                                            property referrer

                                                                                                                            referrer?: false | ReferrerPolicy | undefined;
                                                                                                                            • Controls the Referrer-Policy header, which has the following possible values. false Header will not be send.

                                                                                                                            property xframe

                                                                                                                            xframe?:
                                                                                                                            | true
                                                                                                                            | 'deny'
                                                                                                                            | 'sameorigin'
                                                                                                                            | {
                                                                                                                            /**
                                                                                                                            * an object for specifying the 'allow-from' rule,
                                                                                                                            */
                                                                                                                            rule: 'deny' | 'sameorigin' | 'allow-from';
                                                                                                                            /**
                                                                                                                            * when rule is 'allow-from' this is used to form the rest of the header, otherwise this field is ignored. If rule is 'allow-from' but source is unset, the rule will be automatically changed
                                                                                                                            * to 'sameorigin'.
                                                                                                                            */
                                                                                                                            source: string;
                                                                                                                            }
                                                                                                                            | undefined;
                                                                                                                            • controls the 'X-Frame-Options' header

                                                                                                                            property xss

                                                                                                                            xss?: boolean | undefined;
                                                                                                                            • boolean that controls the 'X-XSS-PROTECTION' header for Internet Explorer. Defaults to true which sets the header to equal '1; mode=block'. Note: this setting can create a security vulnerability in versions of Internet Exploere below 8, as well as unpatched versions of IE8. See here and here for more information. If you actively support old versions of IE, it may be wise to explicitly set this flag to false.

                                                                                                                            interface RouteOptionsValidate

                                                                                                                            interface RouteOptionsValidate {}
                                                                                                                            • { headers: true, params: true, query: true, payload: true, failAction: 'error' }. Request input validation rules for various request components. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsvalidate)

                                                                                                                            property errorFields

                                                                                                                            errorFields?: object | undefined;
                                                                                                                            • none. An optional object with error fields copied into every validation error response. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsvalidateerrorfields)

                                                                                                                            property failAction

                                                                                                                            failAction?: Lifecycle.FailAction | undefined;
                                                                                                                            • 'error' (return a Bad Request (400) error response). A failAction value which determines how to handle failed validations. When set to a function, the err argument includes the type of validation error under err.output.payload.validation.source. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsvalidatefailaction)

                                                                                                                            property headers

                                                                                                                            headers?: RouteOptionsResponseSchema | undefined;
                                                                                                                            • Validation rules for incoming request headers: * If a value is returned, the value is used as the new request.headers value and the original value is stored in request.orig.headers. Otherwise, the headers are left unchanged. If an error is thrown, the error is handled according to failAction. Note that all header field names must be in lowercase to match the headers normalized by node. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsvalidateheaders) true

                                                                                                                            property options

                                                                                                                            options?: ValidationOptions | object | undefined;
                                                                                                                            • An options object passed to the joi rules or the custom validation methods. Used for setting global options such as stripUnknown or abortEarly (the complete list is available here). If a custom validation function (see headers, params, query, or payload above) is defined then options can an arbitrary object that will be passed to this function as the second parameter. The values of the other inputs (i.e. headers, query, params, payload, app, and auth) are added to the options object under the validation context (accessible in rules as Joi.ref('$query.key')). Note that validation is performed in order (i.e. headers, params, query, and payload) and if type casting is used (e.g. converting a string to a number), the value of inputs not yet validated will reflect the raw, unvalidated and unmodified values. If the validation rules for headers, params, query, and payload are defined at both the server routes level and at the route level, the individual route settings override the routes defaults (the rules are not merged). [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsvalidateparams) true

                                                                                                                            property params

                                                                                                                            params?: RouteOptionsResponseSchema | undefined;
                                                                                                                            • Validation rules for incoming request path parameters, after matching the path against the route, extracting any parameters, and storing them in request.params, where: * true - any path parameter value allowed (no validation performed). * a joi validation object. * a validation function using the signature async function(value, options) where: * * value - the request.params object containing the request path parameters. * * options - options. if a value is returned, the value is used as the new request.params value and the original value is stored in request.orig.params. Otherwise, the path parameters are left unchanged. If an error is thrown, the error is handled according to failAction. Note that failing to match the validation rules to the route path parameters definition will cause all requests to fail. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsvalidateparams) true

                                                                                                                            property payload

                                                                                                                            payload?: RouteOptionsResponseSchema | undefined;
                                                                                                                            • Validation rules for incoming request payload (request body), where: * If a value is returned, the value is used as the new request.payload value and the original value is stored in request.orig.payload. Otherwise, the payload is left unchanged. If an error is thrown, the error is handled according to failAction. Note that validating large payloads and modifying them will cause memory duplication of the payload (since the original is kept), as well as the significant performance cost of validating large amounts of data. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsvalidatepayload) true

                                                                                                                            property query

                                                                                                                            query?: RouteOptionsResponseSchema | undefined;
                                                                                                                            • Validation rules for incoming request URI query component (the key-value part of the URI between '?' and '#'). The query is parsed into its individual key-value pairs, decoded, and stored in request.query prior to validation. Where: * If a value is returned, the value is used as the new request.query value and the original value is stored in request.orig.query. Otherwise, the query parameters are left unchanged. If an error is thrown, the error is handled according to failAction. Note that changes to the query parameters will not be reflected in request.url. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-routeoptionsvalidatequery) true

                                                                                                                            property state

                                                                                                                            state?: RouteOptionsResponseSchema | undefined;
                                                                                                                            • Validation rules for incoming cookies. The cookie header is parsed and decoded into the request.state prior to validation. true

                                                                                                                            interface RouteSettings

                                                                                                                            interface RouteSettings extends CommonRouteProperties {}

                                                                                                                              property auth

                                                                                                                              auth?: AuthSettings | undefined;

                                                                                                                                interface ServerApplicationState

                                                                                                                                interface ServerApplicationState {}
                                                                                                                                • User-extensible type for application specific state (server.app).

                                                                                                                                interface ServerAuth

                                                                                                                                interface ServerAuth {}

                                                                                                                                  property api

                                                                                                                                  api: Util.Dictionary<ServerAuthSchemeObjectApi>;
                                                                                                                                  • An object where each key is an authentication strategy name and the value is the exposed strategy API. Available only when the authentication scheme exposes an API by returning an api key in the object returned from its implementation function. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverauthapi)

                                                                                                                                  property settings

                                                                                                                                  readonly settings: {
                                                                                                                                  default: ServerAuthConfig;
                                                                                                                                  };
                                                                                                                                  • Contains the default authentication configuration is a default strategy was set via [server.auth.default()](https://github.com/hapijs/hapi/blob/master/API.md#server.auth.default()).

                                                                                                                                  method default

                                                                                                                                  default: (options: string | ServerAuthConfig) => void;
                                                                                                                                  • Sets a default strategy which is applied to every route where:

                                                                                                                                    Parameter options

                                                                                                                                    one of: * a string with the default strategy name * an authentication configuration object using the same format as the route auth handler options. void. The default does not apply when a route config specifies auth as false, or has an authentication strategy configured (contains the strategy or strategies authentication settings). Otherwise, the route authentication config is applied to the defaults. Note that if the route has authentication configured, the default only applies at the time of adding the route, not at runtime. This means that calling server.auth.default() after adding a route with some authentication config will have no impact on the routes added prior. However, the default will apply to routes added before server.auth.default() is called if those routes lack any authentication config. The default auth strategy configuration can be accessed via server.auth.settings.default. To obtain the active authentication configuration of a route, use server.auth.lookup(request.route). [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverauthdefaultoptions)

                                                                                                                                  method scheme

                                                                                                                                  scheme: (name: string, scheme: ServerAuthScheme) => void;
                                                                                                                                  • Registers an authentication scheme where:

                                                                                                                                    Parameter name

                                                                                                                                    the scheme name.

                                                                                                                                    Parameter scheme

                                                                                                                                    the method implementing the scheme with signature function(server, options) where: * server - a reference to the server object the scheme is added to. * options - (optional) the scheme options argument passed to server.auth.strategy() when instantiation a strategy. void. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverauthschemename-scheme)

                                                                                                                                  method strategy

                                                                                                                                  strategy: (name: string, scheme: string, options?: object) => void;
                                                                                                                                  • Registers an authentication strategy where:

                                                                                                                                    Parameter name

                                                                                                                                    the strategy name.

                                                                                                                                    Parameter scheme

                                                                                                                                    the scheme name (must be previously registered using server.auth.scheme()).

                                                                                                                                    Parameter options

                                                                                                                                    scheme options based on the scheme requirements. Return value: none. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverauthstrategyname-scheme-options)

                                                                                                                                  method test

                                                                                                                                  test: (strategy: string, request: Request) => Promise<AuthenticationData>;
                                                                                                                                  • Tests a request against an authentication strategy where:

                                                                                                                                    Parameter strategy

                                                                                                                                    the strategy name registered with server.auth.strategy().

                                                                                                                                    Parameter request

                                                                                                                                    the request object. an object containing the authentication credentials and artifacts if authentication was successful, otherwise throws an error. Note that the test() method does not take into account the route authentication configuration. It also does not perform payload authentication. It is limited to the basic strategy authentication execution. It does not include verifying scope, entity, or other route properties. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-await-serverauthteststrategy-request)

                                                                                                                                  method verify

                                                                                                                                  verify: (request: Request) => Promise<void>;
                                                                                                                                  • Verify a request's authentication credentials against an authentication strategy. Returns nothing if verification was successful, otherwise throws an error.

                                                                                                                                    Note that the verify() method does not take into account the route authentication configuration or any other information from the request other than the request.auth object. It also does not perform payload authentication. It is limited to verifying that the previously valid credentials are still valid (e.g. have not been revoked or expired). It does not include verifying scope, entity, or other route properties.

                                                                                                                                  interface ServerAuthConfig

                                                                                                                                  interface ServerAuthConfig extends RouteOptionsAccess {}
                                                                                                                                  • An authentication configuration object using the same format as the route auth handler options. For reference [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverauthdefaultoptions)

                                                                                                                                  interface ServerAuthSchemeObject

                                                                                                                                  interface ServerAuthSchemeObject {}
                                                                                                                                  • The scheme method must return an object with the following [See docs](https://github.com/hapijs/hapi/blob/master/API.md#authentication-scheme)

                                                                                                                                  property api

                                                                                                                                  api?: ServerAuthSchemeObjectApi | undefined;
                                                                                                                                  • optional object which is exposed via the [server.auth.api](https://github.com/hapijs/hapi/blob/master/API.md#server.auth.api) object.

                                                                                                                                  property options

                                                                                                                                  options?:
                                                                                                                                  | {
                                                                                                                                  /**
                                                                                                                                  * if true, requires payload validation as part of the scheme and forbids routes from disabling payload auth validation. Defaults to false.
                                                                                                                                  */
                                                                                                                                  payload?: boolean | undefined;
                                                                                                                                  }
                                                                                                                                  | undefined;
                                                                                                                                  • An object with the following keys: * payload

                                                                                                                                  method authenticate

                                                                                                                                  authenticate: (request: Request, h: ResponseToolkit) => Lifecycle.ReturnValue;
                                                                                                                                  • A lifecycle method function called for each incoming request configured with the authentication scheme. The method is provided with two special toolkit methods for returning an authenticated or an unauthenticate result: * h.authenticated() - indicate request authenticated successfully. * h.unauthenticated() - indicate request failed to authenticate.

                                                                                                                                    Parameter request

                                                                                                                                    the request object.

                                                                                                                                    Parameter h

                                                                                                                                    the ResponseToolkit the Lifecycle.ReturnValue

                                                                                                                                  method payload

                                                                                                                                  payload: (request: Request, h: ResponseToolkit) => Lifecycle.ReturnValue;
                                                                                                                                  • A lifecycle method to authenticate the request payload. When the scheme payload() method returns an error with a message, it means payload validation failed due to bad payload. If the error has no message but includes a scheme name (e.g. Boom.unauthorized(null, 'Custom')), authentication may still be successful if the route auth.payload configuration is set to 'optional'.

                                                                                                                                    Parameter request

                                                                                                                                    the request object.

                                                                                                                                    Parameter h

                                                                                                                                    the ResponseToolkit the Lifecycle.ReturnValue

                                                                                                                                  method response

                                                                                                                                  response: (request: Request, h: ResponseToolkit) => Lifecycle.ReturnValue;
                                                                                                                                  • A lifecycle method to decorate the response with authentication headers before the response headers or payload is written.

                                                                                                                                    Parameter request

                                                                                                                                    the request object.

                                                                                                                                    Parameter h

                                                                                                                                    the ResponseToolkit the Lifecycle.ReturnValue

                                                                                                                                  method verify

                                                                                                                                  verify: (auth: RequestAuth) => Promise<void>;
                                                                                                                                  • a method used to verify the authentication credentials provided are still valid (e.g. not expired or revoked after the initial authentication). the method throws an Error when the credentials passed are no longer valid (e.g. expired or revoked). Note that the method does not have access to the original request, only to the credentials and artifacts produced by the authenticate() method.

                                                                                                                                  interface ServerAuthSchemeObjectApi

                                                                                                                                  interface ServerAuthSchemeObjectApi {}

                                                                                                                                    interface ServerCache

                                                                                                                                    interface ServerCache {}
                                                                                                                                    • [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-servercacheoptions)

                                                                                                                                    method provision

                                                                                                                                    provision: (options: ServerOptionsCache) => Promise<void>;
                                                                                                                                    • Provisions a server cache as described in server.cache where:

                                                                                                                                      Parameter options

                                                                                                                                      same as the server cache configuration options. Return value: none. Note that if the server has been initialized or started, the cache will be automatically started to match the state of any other provisioned server cache. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-await-servercacheprovisionoptions)

                                                                                                                                    call signature

                                                                                                                                    <T, O extends CachePolicyOptions<T> = CachePolicyOptions<T>>(options: O): Policy<
                                                                                                                                    T,
                                                                                                                                    O
                                                                                                                                    >;
                                                                                                                                    • Provisions a cache segment within the server cache facility where:

                                                                                                                                      Parameter options

                                                                                                                                      [catbox policy](https://github.com/hapijs/catbox#policy) configuration where: * expiresIn - relative expiration expressed in the number of milliseconds since the item was saved in the cache. Cannot be used together with expiresAt. * expiresAt - time of day expressed in 24h notation using the 'HH:MM' format, at which point all cache records expire. Uses local time. Cannot be used together with expiresIn. * generateFunc - a function used to generate a new cache item if one is not found in the cache when calling get(). The method's signature is async function(id, flags) where: - id - the id string or object provided to the get() method. - flags - an object used to pass back additional flags to the cache where: - ttl - the cache ttl value in milliseconds. Set to 0 to skip storing in the cache. Defaults to the cache global policy. * staleIn - number of milliseconds to mark an item stored in cache as stale and attempt to regenerate it when generateFunc is provided. Must be less than expiresIn. * staleTimeout - number of milliseconds to wait before checking if an item is stale. * generateTimeout - number of milliseconds to wait before returning a timeout error when the generateFunc function takes too long to return a value. When the value is eventually returned, it is stored in the cache for future requests. Required if generateFunc is present. Set to false to disable timeouts which may cause all get() requests to get stuck forever. * generateOnReadError - if false, an upstream cache read error will stop the cache.get() method from calling the generate function and will instead pass back the cache error. Defaults to true. * generateIgnoreWriteError - if false, an upstream cache write error when calling cache.get() will be passed back with the generated value when calling. Defaults to true. * dropOnError - if true, an error or timeout in the generateFunc causes the stale value to be evicted from the cache. Defaults to true. * pendingGenerateTimeout - number of milliseconds while generateFunc call is in progress for a given id, before a subsequent generateFunc call is allowed. Defaults to 0 (no blocking of concurrent generateFunc calls beyond staleTimeout). * cache - the cache name configured in server.cache. Defaults to the default cache. * segment - string segment name, used to isolate cached items within the cache partition. When called within a plugin, defaults to '!name' where 'name' is the plugin name. When called within a server method, defaults to '#name' where 'name' is the server method name. Required when called outside of a plugin. * shared - if true, allows multiple cache provisions to share the same segment. Default to false. Catbox Policy. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-servercacheoptions)

                                                                                                                                    interface ServerEventCriteria

                                                                                                                                    interface ServerEventCriteria<T> {}
                                                                                                                                    • A criteria object with the following optional keys (unless noted otherwise): [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-servereventsoncriteria-listener)

                                                                                                                                      The type parameter T is the type of the name of the event.

                                                                                                                                    property channels

                                                                                                                                    channels?: string | string[] | undefined;
                                                                                                                                    • a string or array of strings specifying the event channels to subscribe to. If the event registration specified a list of allowed channels, the channels array must match the allowed channels. If channels are specified, event updates without any channel designation will not be included in the subscription. Defaults to no channels filter.

                                                                                                                                    property clone

                                                                                                                                    clone?: boolean | undefined;
                                                                                                                                    • if true, the data object passed to server.event.emit() is cloned before it is passed to the listener method. Defaults to the event registration option (which defaults to false).

                                                                                                                                    property count

                                                                                                                                    count?: number | undefined;
                                                                                                                                    • a positive integer indicating the number of times the listener can be called after which the subscription is automatically removed. A count of 1 is the same as calling server.events.once(). Defaults to no limit.

                                                                                                                                    property filter

                                                                                                                                    filter?:
                                                                                                                                    | string
                                                                                                                                    | string[]
                                                                                                                                    | { tags: string | string[]; all?: boolean | undefined }
                                                                                                                                    | undefined;
                                                                                                                                    • filter - the event tags (if present) to subscribe to which can be one of: * a tag string. * an array of tag strings. * an object with the following: * * tags - a tag string or array of tag strings. * * all - if true, all tags must be present for the event update to match the subscription. Defaults to false (at least one matching tag).

                                                                                                                                    property name

                                                                                                                                    name: T;
                                                                                                                                    • (required) the event name string.

                                                                                                                                    property spread

                                                                                                                                    spread?: boolean | undefined;
                                                                                                                                    • if true, and the data object passed to server.event.emit() is an array, the listener method is called with each array element passed as a separate argument. This should only be used when the emitted data structure is known and predictable. Defaults to the event registration option (which defaults to false).

                                                                                                                                    property tags

                                                                                                                                    tags?: boolean | undefined;
                                                                                                                                    • if true and the criteria object passed to server.event.emit() includes tags, the tags are mapped to an object (where each tag string is the key and the value is true) which is appended to the arguments list at the end. Defaults to the event registration option (which defaults to false).

                                                                                                                                    interface ServerEvents

                                                                                                                                    interface ServerEvents extends Podium {}
                                                                                                                                    • Access: podium public interface. The server events emitter. Utilizes the podium with support for event criteria validation, channels, and filters. Use the following methods to interact with server.events: [server.event(events)](https://github.com/hapijs/hapi/blob/master/API.md#server.event()) - register application events. [server.events.emit(criteria, data)](https://github.com/hapijs/hapi/blob/master/API.md#server.events.emit()) - emit server events. [server.events.on(criteria, listener)](https://github.com/hapijs/hapi/blob/master/API.md#server.events.on()) - subscribe to all events. [server.events.once(criteria, listener)](https://github.com/hapijs/hapi/blob/master/API.md#server.events.once()) - subscribe to Other methods include: server.events.removeListener(name, listener), server.events.removeAllListeners(name), and server.events.hasListeners(name). [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverevents)

                                                                                                                                    method hasListeners

                                                                                                                                    hasListeners: (name: string) => boolean;
                                                                                                                                    • The follow method is only mentioned in Hapi API. The doc about that method can be found [here](https://github.com/hapijs/podium/blob/master/API.md#podiumhaslistenersname) [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverevents)

                                                                                                                                    method on

                                                                                                                                    on: {
                                                                                                                                    (
                                                                                                                                    criteria: 'log' | ServerEventCriteria<'log'>,
                                                                                                                                    listener: LogEventHandler
                                                                                                                                    ): this;
                                                                                                                                    (
                                                                                                                                    criteria: 'request' | ServerEventCriteria<'request'>,
                                                                                                                                    listener: RequestEventHandler
                                                                                                                                    ): this;
                                                                                                                                    (
                                                                                                                                    criteria: 'response' | ServerEventCriteria<'response'>,
                                                                                                                                    listener: ResponseEventHandler
                                                                                                                                    ): this;
                                                                                                                                    (
                                                                                                                                    criteria: 'route' | ServerEventCriteria<'route'>,
                                                                                                                                    listener: RouteEventHandler
                                                                                                                                    ): this;
                                                                                                                                    (
                                                                                                                                    criteria: 'start' | ServerEventCriteria<'start'>,
                                                                                                                                    listener: StartEventHandler
                                                                                                                                    ): this;
                                                                                                                                    (
                                                                                                                                    criteria: 'stop' | ServerEventCriteria<'stop'>,
                                                                                                                                    listener: StopEventHandler
                                                                                                                                    ): this;
                                                                                                                                    };
                                                                                                                                    • Subscribe to an event where:

                                                                                                                                      Parameter criteria

                                                                                                                                      the subscription criteria which must be one of: * event name string which can be any of the built-in server events * a custom application event registered with server.event(). * a criteria object

                                                                                                                                      Parameter listener

                                                                                                                                      the handler method set to receive event updates. The function signature depends on the event argument, and the spread and tags options. Return value: none. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-servereventsoncriteria-listener) See ['log' event](https://github.com/hapijs/hapi/blob/master/API.md#-log-event) See ['request' event](https://github.com/hapijs/hapi/blob/master/API.md#-request-event) See ['response' event](https://github.com/hapijs/hapi/blob/master/API.md#-response-event) See ['route' event](https://github.com/hapijs/hapi/blob/master/API.md#-route-event) See ['start' event](https://github.com/hapijs/hapi/blob/master/API.md#-start-event) See ['stop' event](https://github.com/hapijs/hapi/blob/master/API.md#-stop-event)

                                                                                                                                    method once

                                                                                                                                    once: {
                                                                                                                                    (
                                                                                                                                    criteria: 'log' | ServerEventCriteria<'log'>,
                                                                                                                                    listener: LogEventHandler
                                                                                                                                    ): this;
                                                                                                                                    (
                                                                                                                                    criteria: 'request' | ServerEventCriteria<'request'>,
                                                                                                                                    listener: RequestEventHandler
                                                                                                                                    ): this;
                                                                                                                                    (
                                                                                                                                    criteria: 'response' | ServerEventCriteria<'response'>,
                                                                                                                                    listener: ResponseEventHandler
                                                                                                                                    ): this;
                                                                                                                                    (
                                                                                                                                    criteria: 'route' | ServerEventCriteria<'route'>,
                                                                                                                                    listener: RouteEventHandler
                                                                                                                                    ): this;
                                                                                                                                    (
                                                                                                                                    criteria: 'start' | ServerEventCriteria<'start'>,
                                                                                                                                    listener: StartEventHandler
                                                                                                                                    ): this;
                                                                                                                                    (
                                                                                                                                    criteria: 'stop' | ServerEventCriteria<'stop'>,
                                                                                                                                    listener: StopEventHandler
                                                                                                                                    ): this;
                                                                                                                                    (criteria: string | ServerEventCriteria<string>): Promise<any>;
                                                                                                                                    };
                                                                                                                                    • Same as calling [server.events.on()](https://github.com/hapijs/hapi/blob/master/API.md#server.events.on()) with the count option set to 1.

                                                                                                                                      Parameter criteria

                                                                                                                                      the subscription criteria which must be one of: * event name string which can be any of the built-in server events * a custom application event registered with server.event(). * a criteria object

                                                                                                                                      Parameter listener

                                                                                                                                      the handler method set to receive event updates. The function signature depends on the event argument, and the spread and tags options. Return value: none. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-servereventsoncecriteria-listener)

                                                                                                                                    • Same as calling server.events.on() with the count option set to 1.

                                                                                                                                      Parameter criteria

                                                                                                                                      the subscription criteria which must be one of: * event name string which can be any of the built-in server events * a custom application event registered with server.event(). * a criteria object Return value: a promise that resolves when the event is emitted. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-await-servereventsoncecriteria)

                                                                                                                                    method removeAllListeners

                                                                                                                                    removeAllListeners: (name: string) => this;
                                                                                                                                    • The follow method is only mentioned in Hapi API. The doc about that method can be found [here](https://github.com/hapijs/podium/blob/master/API.md#podiumremovealllistenersname) [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverevents)

                                                                                                                                    method removeListener

                                                                                                                                    removeListener: (name: string, listener: Podium.Listener) => this;
                                                                                                                                    • The follow method is only mentioned in Hapi API. The doc about that method can be found [here](https://github.com/hapijs/podium/blob/master/API.md#podiumremovelistenername-listener) [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverevents)

                                                                                                                                    interface ServerEventsApplicationObject

                                                                                                                                    interface ServerEventsApplicationObject {}
                                                                                                                                    • Object that it will be used in Event [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-servereventevents)

                                                                                                                                    property channels

                                                                                                                                    channels?: string | string[] | undefined;
                                                                                                                                    • a string or array of strings specifying the event channels available. Defaults to no channel restrictions (event updates can specify a channel or not).

                                                                                                                                    property clone

                                                                                                                                    clone?: boolean | undefined;
                                                                                                                                    • if true, the data object passed to server.events.emit() is cloned before it is passed to the listeners (unless an override specified by each listener). Defaults to false (data is passed as-is).

                                                                                                                                    property name

                                                                                                                                    name: string;
                                                                                                                                    • the event name string (required).

                                                                                                                                    property shared

                                                                                                                                    shared?: boolean | undefined;
                                                                                                                                    • if true, the same event name can be registered multiple times where the second registration is ignored. Note that if the registration config is changed between registrations, only the first configuration is used. Defaults to false (a duplicate registration will throw an error).

                                                                                                                                    property spread

                                                                                                                                    spread?: boolean | undefined;
                                                                                                                                    • if true, the data object passed to server.event.emit() must be an array and the listener method is called with each array element passed as a separate argument (unless an override specified by each listener). This should only be used when the emitted data structure is known and predictable. Defaults to false (data is emitted as a single argument regardless of its type).

                                                                                                                                    property tags

                                                                                                                                    tags?: boolean | undefined;
                                                                                                                                    • if true and the criteria object passed to server.event.emit() includes tags, the tags are mapped to an object (where each tag string is the key and the value is true) which is appended to the arguments list at the end. A configuration override can be set by each listener. Defaults to false.

                                                                                                                                    interface ServerExtEventsObject

                                                                                                                                    interface ServerExtEventsObject {}
                                                                                                                                    • [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverextevents) Registers an extension function in one of the request lifecycle extension points where:

                                                                                                                                      Parameter events

                                                                                                                                      an object or array of objects with the following: * type - (required) the extension point event name. The available extension points include the request extension points as well as the following server extension points: * * 'onPreStart' - called before the connection listeners are started. * * 'onPostStart' - called after the connection listeners are started. * * 'onPreStop' - called before the connection listeners are stopped. * * 'onPostStop' - called after the connection listeners are stopped. * method - (required) a function or an array of functions to be executed at a specified point during request processing. The required extension function signature is: * * server extension points: async function(server) where: * * * server - the server object. * * * this - the object provided via options.bind or the current active context set with server.bind(). * * request extension points: a lifecycle method. * options - (optional) an object with the following: * * before - a string or array of strings of plugin names this method must execute before (on the same event). Otherwise, extension methods are executed in the order added. * * after - a string or array of strings of plugin names this method must execute after (on the same event). Otherwise, extension methods are executed in the order added. * * bind - a context object passed back to the provided method (via this) when called. Ignored if the method is an arrow function. * * sandbox - if set to 'plugin' when adding a request extension points the extension is only added to routes defined by the current plugin. Not allowed when configuring route-level extensions, or when adding server extensions. Defaults to 'server' which applies to any route added to the server the extension is added to. void

                                                                                                                                    property method

                                                                                                                                    method: ServerExtPointFunction | ServerExtPointFunction[];
                                                                                                                                    • (required) a function or an array of functions to be executed at a specified point during request processing. The required extension function signature is: * server extension points: async function(server) where: * * server - the server object. * * this - the object provided via options.bind or the current active context set with server.bind(). * request extension points: a lifecycle method.

                                                                                                                                    property options

                                                                                                                                    options?: ServerExtOptions | undefined;

                                                                                                                                      property type

                                                                                                                                      type: ServerExtType;
                                                                                                                                      • (required) the extension point event name. The available extension points include the request extension points as well as the following server extension points: * 'onPreStart' - called before the connection listeners are started. * 'onPostStart' - called after the connection listeners are started. * 'onPreStop' - called before the connection listeners are stopped.

                                                                                                                                      interface ServerExtEventsRequestObject

                                                                                                                                      interface ServerExtEventsRequestObject {}
                                                                                                                                      • [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverextevents) Registers an extension function in one of the request lifecycle extension points where:

                                                                                                                                        Parameter events

                                                                                                                                        an object or array of objects with the following: * type - (required) the extension point event name. The available extension points include the request extension points as well as the following server extension points: * * 'onPreStart' - called before the connection listeners are started. * * 'onPostStart' - called after the connection listeners are started. * * 'onPreStop' - called before the connection listeners are stopped. * * 'onPostStop' - called after the connection listeners are stopped. * method - (required) a function or an array of functions to be executed at a specified point during request processing. The required extension function signature is: * * server extension points: async function(server) where: * * * server - the server object. * * * this - the object provided via options.bind or the current active context set with server.bind(). * * request extension points: a lifecycle method. * options - (optional) an object with the following: * * before - a string or array of strings of plugin names this method must execute before (on the same event). Otherwise, extension methods are executed in the order added. * * after - a string or array of strings of plugin names this method must execute after (on the same event). Otherwise, extension methods are executed in the order added. * * bind - a context object passed back to the provided method (via this) when called. Ignored if the method is an arrow function. * * sandbox - if set to 'plugin' when adding a request extension points the extension is only added to routes defined by the current plugin. Not allowed when configuring route-level extensions, or when adding server extensions. Defaults to 'server' which applies to any route added to the server the extension is added to. void

                                                                                                                                      property method

                                                                                                                                      method: Lifecycle.Method | Lifecycle.Method[];
                                                                                                                                      • (required) a function or an array of functions to be executed at a specified point during request processing. The required extension function signature is: * server extension points: async function(server) where: * * server - the server object. * * this - the object provided via options.bind or the current active context set with server.bind(). * request extension points: a lifecycle method.

                                                                                                                                      property options

                                                                                                                                      options?: ServerExtOptions | undefined;
                                                                                                                                      • (optional) an object with the following: * before - a string or array of strings of plugin names this method must execute before (on the same event). Otherwise, extension methods are executed in the order added. * after - a string or array of strings of plugin names this method must execute after (on the same event). Otherwise, extension methods are executed in the order added. * bind - a context object passed back to the provided method (via this) when called. Ignored if the method is an arrow function. * sandbox - if set to 'plugin' when adding a request extension points the extension is only added to routes defined by the current plugin. Not allowed when configuring route-level extensions, or when adding server extensions. Defaults to 'server' which applies to any route added to the server the extension is added to.

                                                                                                                                      property type

                                                                                                                                      type: ServerRequestExtType;
                                                                                                                                      • (required) the extension point event name. The available extension points include the request extension points as well as the following server extension points: * 'onPreStart' - called before the connection listeners are started. * 'onPostStart' - called after the connection listeners are started. * 'onPreStop' - called before the connection listeners are stopped. * 'onPostStop' - called after the connection listeners are stopped.

                                                                                                                                      interface ServerExtOptions

                                                                                                                                      interface ServerExtOptions {}
                                                                                                                                      • An object with the following: * before - a string or array of strings of plugin names this method must execute before (on the same event). Otherwise, extension methods are executed in the order added. * after - a string or array of strings of plugin names this method must execute after (on the same event). Otherwise, extension methods are executed in the order added. * bind - a context object passed back to the provided method (via this) when called. Ignored if the method is an arrow function. * sandbox - if set to 'plugin' when adding a request extension points the extension is only added to routes defined by the current plugin. Not allowed when configuring route-level extensions, or when adding server extensions. Defaults to 'server' which applies to any route added to the server the extension is added to. For context [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverextevents)

                                                                                                                                      property after

                                                                                                                                      after?: string | string[] | undefined;
                                                                                                                                      • a string or array of strings of plugin names this method must execute after (on the same event). Otherwise, extension methods are executed in the order added.

                                                                                                                                      property before

                                                                                                                                      before?: string | string[] | undefined;
                                                                                                                                      • a string or array of strings of plugin names this method must execute before (on the same event). Otherwise, extension methods are executed in the order added.

                                                                                                                                      property bind

                                                                                                                                      bind?: object | undefined;
                                                                                                                                      • a context object passed back to the provided method (via this) when called. Ignored if the method is an arrow function.

                                                                                                                                      property sandbox

                                                                                                                                      sandbox?: 'server' | 'plugin' | undefined;
                                                                                                                                      • if set to 'plugin' when adding a request extension points the extension is only added to routes defined by the current plugin. Not allowed when configuring route-level extensions, or when adding server extensions. Defaults to 'server' which applies to any route added to the server the extension is added to.

                                                                                                                                      interface ServerInfo

                                                                                                                                      interface ServerInfo {}
                                                                                                                                      • [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serverinfo) An object containing information about the server where:

                                                                                                                                      property address

                                                                                                                                      address: undefined | string;
                                                                                                                                      • the active IP address the connection was bound to after starting. Set to undefined until the server has been started or when using a non TCP port (e.g. UNIX domain socket).

                                                                                                                                      property created

                                                                                                                                      created: number;
                                                                                                                                      • server creation timestamp.

                                                                                                                                      property host

                                                                                                                                      host: string;
                                                                                                                                      • The [host](https://github.com/hapijs/hapi/blob/master/API.md#server.options.host) configuration value.

                                                                                                                                      property id

                                                                                                                                      id: string;
                                                                                                                                      • a unique server identifier (using the format '{hostname}:{pid}:{now base36}').

                                                                                                                                      property port

                                                                                                                                      port: number | string;
                                                                                                                                      • the connection [port](https://github.com/hapijs/hapi/blob/master/API.md#server.options.port) based on the following rules: * before the server has been started: the configured port value. * after the server has been started: the actual port assigned when no port is configured or was set to 0.

                                                                                                                                      property protocol

                                                                                                                                      protocol: 'http' | 'https' | 'socket';
                                                                                                                                      • the protocol used: * 'http' - HTTP. * 'https' - HTTPS. * 'socket' - UNIX domain socket or Windows named pipe.

                                                                                                                                      property started

                                                                                                                                      started: number;
                                                                                                                                      • server start timestamp (0 when stopped).

                                                                                                                                      property uri

                                                                                                                                      uri: string;
                                                                                                                                      • a string representing the connection (e.g. 'http://example.com:8080' or 'socket:/unix/domain/socket/path'). Contains the uri value if set, otherwise constructed from the available settings. If no port is configured or is set to 0, the uri will not include a port component until the server is started.

                                                                                                                                      interface ServerInjectOptions

                                                                                                                                      interface ServerInjectOptions extends Shot.RequestOptions {}
                                                                                                                                      • An object with: * method - (optional) the request HTTP method (e.g. 'POST'). Defaults to 'GET'. * url - (required) the request URL. If the URI includes an authority (e.g. 'example.com:8080'), it is used to automatically set an HTTP 'Host' header, unless one was specified in headers. * headers - (optional) an object with optional request headers where each key is the header name and the value is the header content. Defaults to no additions to the default shot headers. * payload - (optional) an string, buffer or object containing the request payload. In case of an object it will be converted to a string for you. Defaults to no payload. Note that payload processing defaults to 'application/json' if no 'Content-Type' header provided. * credentials - (optional) an credentials object containing authentication information. The credentials are used to bypass the default authentication strategies, and are validated directly as if they were received via an authentication scheme. Defaults to no credentials. * artifacts - (optional) an artifacts object containing authentication artifact information. The artifacts are used to bypass the default authentication strategies, and are validated directly as if they were received via an authentication scheme. Ignored if set without credentials. Defaults to no artifacts. * app - (optional) sets the initial value of request.app, defaults to {}. * plugins - (optional) sets the initial value of request.plugins, defaults to {}. * allowInternals - (optional) allows access to routes with config.isInternal set to true. Defaults to false. * remoteAddress - (optional) sets the remote address for the incoming connection. * simulate - (optional) an object with options used to simulate client request stream conditions for testing: * error - if true, emits an 'error' event after payload transmission (if any). Defaults to false. * close - if true, emits a 'close' event after payload transmission (if any). Defaults to false. * end - if false, does not end the stream. Defaults to true. * split - indicates whether the request payload will be split into chunks. Defaults to undefined, meaning payload will not be chunked. * validate - (optional) if false, the options inputs are not validated. This is recommended for run-time usage of inject() to make it perform faster where input validation can be tested separately. For context [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-await-serverinjectoptions) For context [Shot module](https://github.com/hapijs/shot)

                                                                                                                                      property allowInternals

                                                                                                                                      allowInternals?: boolean | undefined;
                                                                                                                                      • allows access to routes with config.isInternal set to true. Defaults to false.

                                                                                                                                      property app

                                                                                                                                      app?: RequestApplicationState | undefined;
                                                                                                                                      • sets the initial value of request.app, defaults to {}.

                                                                                                                                      property auth

                                                                                                                                      auth?:
                                                                                                                                      | {
                                                                                                                                      /**
                                                                                                                                      * The authentication strategy name matching the provided credentials.
                                                                                                                                      */
                                                                                                                                      strategy: string;
                                                                                                                                      /**
                                                                                                                                      * The credentials are used to bypass the default authentication strategies,
                                                                                                                                      * and are validated directly as if they were received via an authentication scheme.
                                                                                                                                      */
                                                                                                                                      credentials: AuthCredentials;
                                                                                                                                      /**
                                                                                                                                      * The artifacts are used to bypass the default authentication strategies,
                                                                                                                                      * and are validated directly as if they were received via an authentication scheme. Defaults to no artifacts.
                                                                                                                                      */
                                                                                                                                      artifacts?: AuthArtifacts | undefined;
                                                                                                                                      }
                                                                                                                                      | undefined;
                                                                                                                                      • Authentication bypass options.

                                                                                                                                      property plugins

                                                                                                                                      plugins?: PluginsStates | undefined;
                                                                                                                                      • sets the initial value of request.plugins, defaults to {}.

                                                                                                                                      interface ServerInjectResponse

                                                                                                                                      interface ServerInjectResponse extends Shot.ResponseObject {}
                                                                                                                                      • A response object with the following properties: * statusCode - the HTTP status code. * headers - an object containing the headers set. * payload - the response payload string. * rawPayload - the raw response payload buffer. * raw - an object with the injection request and response objects: * req - the simulated node request object. * res - the simulated node response object. * result - the raw handler response (e.g. when not a stream or a view) before it is serialized for transmission. If not available, the value is set to payload. Useful for inspection and reuse of the internal objects returned (instead of parsing the response string). * request - the request object. For context [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-await-serverinjectoptions) For context [Shot module](https://github.com/hapijs/shot)

                                                                                                                                      property request

                                                                                                                                      request: Request;
                                                                                                                                      • the request object.

                                                                                                                                      property result

                                                                                                                                      result: object | undefined;
                                                                                                                                      • the raw handler response (e.g. when not a stream or a view) before it is serialized for transmission. If not available, the value is set to payload. Useful for inspection and reuse of the internal objects returned (instead of parsing the response string).

                                                                                                                                      interface ServerMethodCache

                                                                                                                                      interface ServerMethodCache extends PolicyOptions<any> {}
                                                                                                                                      • The same cache configuration used in server.cache(). The generateTimeout option is required. For reference [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-servermethodname-method-options) For reference [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-servercacheoptions)

                                                                                                                                      property generateTimeout

                                                                                                                                      generateTimeout: number | false;

                                                                                                                                        interface ServerMethodConfigurationObject

                                                                                                                                        interface ServerMethodConfigurationObject {}
                                                                                                                                        • An object or an array of objects where each one contains: * name - the method name. * method - the method function. * options - (optional) settings. For reference [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-servermethodmethods)

                                                                                                                                        property method

                                                                                                                                        method: ServerMethod;
                                                                                                                                        • the method function.

                                                                                                                                        property name

                                                                                                                                        name: string;
                                                                                                                                        • the method name.

                                                                                                                                        property options

                                                                                                                                        options?: ServerMethodOptions | undefined;
                                                                                                                                        • (optional) settings.

                                                                                                                                        interface ServerMethodOptions

                                                                                                                                        interface ServerMethodOptions {}
                                                                                                                                        • Configuration object: * bind - a context object passed back to the method function (via this) when called. Defaults to active context (set via server.bind() when the method is registered. Ignored if the method is an arrow function. * cache - the same cache configuration used in server.cache(). The generateTimeout option is required. * generateKey - a function used to generate a unique key (for caching) from the arguments passed to the method function (the flags argument is not passed as input). The server will automatically generate a unique key if the function's arguments are all of types 'string', 'number', or 'boolean'. However if the method uses other types of arguments, a key generation function must be provided which takes the same arguments as the function and returns a unique string (or null if no key can be generated). For reference [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-servermethodname-method-options)

                                                                                                                                        property bind

                                                                                                                                        bind?: object | undefined;
                                                                                                                                        • a context object passed back to the method function (via this) when called. Defaults to active context (set via server.bind() when the method is registered. Ignored if the method is an arrow function.

                                                                                                                                        property cache

                                                                                                                                        cache?: ServerMethodCache | undefined;
                                                                                                                                        • the same cache configuration used in server.cache(). The generateTimeout option is required.

                                                                                                                                        method generateKey

                                                                                                                                        generateKey: (...args: any[]) => string | null;
                                                                                                                                        • a function used to generate a unique key (for caching) from the arguments passed to the method function (the flags argument is not passed as input). The server will automatically generate a unique key if the function's arguments are all of types 'string', 'number', or 'boolean'. However if the method uses other types of arguments, a key generation function must be provided which takes the same arguments as the function and returns a unique string (or null if no key can be generated).

                                                                                                                                        interface ServerMethods

                                                                                                                                        interface ServerMethods extends Util.Dictionary<ServerMethod> {}
                                                                                                                                        • An empty interface to allow typings of custom server.methods.

                                                                                                                                        interface ServerOptions

                                                                                                                                        interface ServerOptions {}
                                                                                                                                        • The server options control the behavior of the server object. Note that the options object is deeply cloned (with the exception of listener which is shallowly copied) and should not contain any values that are unsafe to perform deep copy on. All options are optionals. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-server-options)

                                                                                                                                        property address

                                                                                                                                        address?: string | undefined;
                                                                                                                                        • '0.0.0.0' (all available network interfaces). Sets the hostname or IP address the server will listen on. If not configured, defaults to host if present, otherwise to all available network interfaces. Set to '127.0.0.1' or 'localhost' to restrict the server to only those coming from the same host. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serveroptionsaddress)

                                                                                                                                        property app

                                                                                                                                        app?: ServerOptionsApp | undefined;
                                                                                                                                        • {}. Provides application-specific configuration which can later be accessed via server.settings.app. The framework does not interact with this object. It is simply a reference made available anywhere a server reference is provided. Note the difference between server.settings.app which is used to store static configuration values and server.app which is meant for storing run-time state. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serveroptionsapp)

                                                                                                                                        property autoListen

                                                                                                                                        autoListen?: boolean | undefined;
                                                                                                                                        • true. Used to disable the automatic initialization of the listener. When false, indicates that the listener will be started manually outside the framework. Cannot be set to true along with a port value. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serveroptionsautolisten)

                                                                                                                                        property cache

                                                                                                                                        cache?: CacheProvider | ServerOptionsCache | ServerOptionsCache[] | undefined;
                                                                                                                                        • { engine: require('@hapi/catbox-memory' }. Sets up server-side caching providers. Every server includes a default cache for storing application state. By default, a simple memory-based cache is created which has limited capacity and capabilities. hapi uses catbox for its cache implementation which includes support for common storage solutions (e.g. Redis, MongoDB, Memcached, Riak, among others). Caching is only utilized if methods and plugins explicitly store their state in the cache. The server cache configuration only defines the storage container itself. The configuration can be assigned one or more (array): * a class or prototype function (usually obtained by calling require() on a catbox strategy such as require('@hapi/catbox-redis')). A new catbox client will be created internally using this function. * a configuration object with the following: * * engine - a class, a prototype function, or a catbox engine object. * * name - an identifier used later when provisioning or configuring caching for server methods or plugins. Each cache name must be unique. A single item may omit the name option which defines the default cache. If every cache includes a name, a default memory cache is provisioned as well. * * shared - if true, allows multiple cache users to share the same segment (e.g. multiple methods using the same cache storage container). Default to false. * * partition - (optional) string used to isolate cached data. Defaults to 'hapi-cache'. * * other options passed to the catbox strategy used. Other options are only passed to catbox when engine above is a class or function and ignored if engine is a catbox engine object). [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serveroptionscache)

                                                                                                                                        property compression

                                                                                                                                        compression?: boolean | ServerOptionsCompression | undefined;
                                                                                                                                        • { minBytes: 1024 }. Defines server handling of content encoding requests. If false, response content encoding is disabled and no compression is performed by the server.

                                                                                                                                        property debug

                                                                                                                                        debug?:
                                                                                                                                        | false
                                                                                                                                        | {
                                                                                                                                        log?: string[] | false | undefined;
                                                                                                                                        request?: string[] | false | undefined;
                                                                                                                                        }
                                                                                                                                        | undefined;
                                                                                                                                        • { request: ['implementation'] }. Determines which logged events are sent to the console. This should only be used for development and does not affect which events are actually logged internally and recorded. Set to false to disable all console logging, or to an object with: * log - a string array of server log tags to be displayed via console.error() when the events are logged via server.log() as well as internally generated server logs. Defaults to no output. * request - a string array of request log tags to be displayed via console.error() when the events are logged via request.log() as well as internally generated request logs. For example, to display all errors, set the option to ['error']. To turn off all console debug messages set it to false. To display all request logs, set it to '*'. Defaults to uncaught errors thrown in external code (these errors are handled automatically and result in an Internal Server Error response) or runtime errors due to developer error. For example, to display all errors, set the log or request to ['error']. To turn off all output set the log or request to false. To display all server logs, set the log or request to '*'. To disable all debug information, set debug to false.

                                                                                                                                        property host

                                                                                                                                        host?: string | undefined;
                                                                                                                                        • the operating system hostname and if not available, to 'localhost'. The public hostname or IP address. Used to set server.info.host and server.info.uri and as address is none provided.

                                                                                                                                        property listener

                                                                                                                                        listener?: http.Server | undefined;
                                                                                                                                        • none. An optional node HTTP (or HTTPS) http.Server object (or an object with a compatible interface). If the listener needs to be manually started, set autoListen to false. If the listener uses TLS, set tls to true.

                                                                                                                                        property load

                                                                                                                                        load?:
                                                                                                                                        | {
                                                                                                                                        /** the frequency of sampling in milliseconds. When set to 0, the other load options are ignored. Defaults to 0 (no sampling). */
                                                                                                                                        sampleInterval?: number | undefined;
                                                                                                                                        /** maximum V8 heap size over which incoming requests are rejected with an HTTP Server Timeout (503) response. Defaults to 0 (no limit). */
                                                                                                                                        maxHeapUsedBytes?: number | undefined;
                                                                                                                                        /**
                                                                                                                                        * maximum process RSS size over which incoming requests are rejected with an HTTP Server Timeout (503) response. Defaults to 0 (no limit).
                                                                                                                                        */
                                                                                                                                        maxRssBytes?: number | undefined;
                                                                                                                                        /**
                                                                                                                                        * maximum event loop delay duration in milliseconds over which incoming requests are rejected with an HTTP Server Timeout (503) response.
                                                                                                                                        * Defaults to 0 (no limit).
                                                                                                                                        */
                                                                                                                                        maxEventLoopDelay?: number | undefined;
                                                                                                                                        }
                                                                                                                                        | undefined;
                                                                                                                                        • { sampleInterval: 0 }. Server excessive load handling limits where: * sampleInterval - the frequency of sampling in milliseconds. When set to 0, the other load options are ignored. Defaults to 0 (no sampling). * maxHeapUsedBytes - maximum V8 heap size over which incoming requests are rejected with an HTTP Server Timeout (503) response. Defaults to 0 (no limit). * maxRssBytes - maximum process RSS size over which incoming requests are rejected with an HTTP Server Timeout (503) response. Defaults to 0 (no limit). * maxEventLoopDelay - maximum event loop delay duration in milliseconds over which incoming requests are rejected with an HTTP Server Timeout (503) response. Defaults to 0 (no limit).

                                                                                                                                        property mime

                                                                                                                                        mime?: MimosOptions | undefined;
                                                                                                                                        • none. Options passed to the mimos module when generating the mime database used by the server (and accessed via server.mime): * override - an object hash that is merged into the built in mime information specified here. Each key value pair represents a single mime object. Each override value must contain: * key - the lower-cased mime-type string (e.g. 'application/javascript'). * value - an object following the specifications outlined here. Additional values include: * * type - specify the type value of result objects, defaults to key. * * predicate - method with signature function(mime) when this mime type is found in the database, this function will execute to allows customizations. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-serveroptionsmime)

                                                                                                                                        property plugins

                                                                                                                                        plugins?: PluginSpecificConfiguration | undefined;
                                                                                                                                        • {}. Plugin-specific configuration which can later be accessed via server.settings.plugins. plugins is an object where each key is a plugin name and the value is the configuration. Note the difference between server.settings.plugins which is used to store static configuration values and server.plugins which is meant for storing run-time state.

                                                                                                                                        property port

                                                                                                                                        port?: number | string | undefined;
                                                                                                                                        • 0 (an ephemeral port). The TCP port the server will listen to. Defaults the next available port when the server is started (and assigned to server.info.port). If port is a string containing a '/' character, it is used as a UNIX domain socket path. If it starts with '.\pipe', it is used as a Windows named pipe.

                                                                                                                                        property query

                                                                                                                                        query?:
                                                                                                                                        | {
                                                                                                                                        /**
                                                                                                                                        * the method must return an object where each key is a parameter and matching value is the parameter value.
                                                                                                                                        * If the method throws, the error is used as the response or returned when `request.setUrl` is called.
                                                                                                                                        */
                                                                                                                                        parser(raw: Util.Dictionary<string>): Util.Dictionary<any>;
                                                                                                                                        }
                                                                                                                                        | undefined;
                                                                                                                                        • Query parameter configuration.

                                                                                                                                        property router

                                                                                                                                        router?:
                                                                                                                                        | {
                                                                                                                                        isCaseSensitive?: boolean | undefined;
                                                                                                                                        stripTrailingSlash?: boolean | undefined;
                                                                                                                                        }
                                                                                                                                        | undefined;
                                                                                                                                        • { isCaseSensitive: true, stripTrailingSlash: false }. Controls how incoming request URIs are matched against the routing table: * isCaseSensitive - determines whether the paths '/example' and '/EXAMPLE' are considered different resources. Defaults to true. * stripTrailingSlash - removes trailing slashes on incoming paths. Defaults to false.

                                                                                                                                        property routes

                                                                                                                                        routes?: RouteOptions | undefined;
                                                                                                                                        • none. A route options object used as the default configuration for every route.

                                                                                                                                        property state

                                                                                                                                        state?:
                                                                                                                                        | {
                                                                                                                                        strictHeader?: boolean | undefined;
                                                                                                                                        ignoreErrors?: boolean | undefined;
                                                                                                                                        isSecure?: boolean | undefined;
                                                                                                                                        isHttpOnly?: boolean | undefined;
                                                                                                                                        isSameSite?: SameSitePolicy | undefined;
                                                                                                                                        encoding?:
                                                                                                                                        | 'none'
                                                                                                                                        | 'base64'
                                                                                                                                        | 'base64json'
                                                                                                                                        | 'form'
                                                                                                                                        | 'iron'
                                                                                                                                        | undefined;
                                                                                                                                        }
                                                                                                                                        | undefined;
                                                                                                                                        • Default value: { strictHeader: true, ignoreErrors: false, isSecure: true, isHttpOnly: true, isSameSite: 'Strict', encoding: 'none' } Sets the default configuration for every state (cookie) set explicitly via server.state() or implicitly (without definition) using the state configuration object.

                                                                                                                                        property tls

                                                                                                                                        tls?: boolean | https.ServerOptions | undefined;
                                                                                                                                        • none. Used to create an HTTPS connection. The tls object is passed unchanged to the node HTTPS server as described in the node HTTPS documentation.

                                                                                                                                        property uri

                                                                                                                                        uri?: string | undefined;
                                                                                                                                        • constructed from runtime server information. The full public URI without the path (e.g. 'http://example.com:8080'). If present, used as the server server.info.uri, otherwise constructed from the server settings.

                                                                                                                                        interface ServerOptionsApp

                                                                                                                                        interface ServerOptionsApp {}
                                                                                                                                        • Empty interface to allow for custom augmentation.

                                                                                                                                        interface ServerOptionsCache

                                                                                                                                        interface ServerOptionsCache extends PolicyOptions<any> {}
                                                                                                                                        • hapi uses catbox for its cache implementation which includes support for common storage solutions (e.g. Redis, MongoDB, Memcached, Riak, among others). Caching is only utilized if methods and plugins explicitly store their state in the cache. [See docs](https://github.com/hapijs/hapi/blob/master/API.md#-cache)

                                                                                                                                        property engine

                                                                                                                                        engine?: ClientApi<any> | undefined;
                                                                                                                                        • catbox engine object.

                                                                                                                                        property name

                                                                                                                                        name?: string | undefined;