Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "net/http-server/docs/types/index.d"

Index

Type aliases

Binary

Binary: (error: Error | null, server: any) => void

Callback invoked after creating a server.

param

error object or null

param

server object

Type declaration

    • (error: Error | null, server: any): void
    • Parameters

      • error: Error | null
      • server: any

      Returns void

BinaryListener

BinaryListener: (request: any, response: any) => void

Request callback.

param

request object

param

response object

Type declaration

    • (request: any, response: any): void
    • Parameters

      • request: any
      • response: any

      Returns void

Callback

Callback: Nullary | Unary | Binary

Callback invoked after creating a server.

param

error object or null

param

server object

Nullary

Nullary: () => void

Callback invoked after creating a server.

Type declaration

    • (): void
    • Returns void

NullaryListener

NullaryListener: () => void

Request callback.

Type declaration

    • (): void
    • Returns void

RequestListener

Request callback.

param

request object

param

response object

Unary

Unary: (error: Error | null) => void

Callback invoked after creating a server.

param

error object or null

Type declaration

    • (error: Error | null): void
    • Parameters

      • error: Error | null

      Returns void

UnaryListener

UnaryListener: (request: any) => void

Request callback.

param

request object

Type declaration

    • (request: any): void
    • Parameters

      • request: any

      Returns void

createServer

createServer: (done: Callback) => void

Creates an HTTP server.

param

callback to invoke after creating the server

Type declaration

Functions

httpServer

  • Returns a function which creates an HTTP server.

    Parameters

    • Optional requestListener: RequestListener

      callback invoked upon receiving an HTTP request

    Returns createServer

    function which creates an HTTP server

    Example

    var createServer = httpServer();

    Example

    function onRequest( request, response ) {
        console.log( request.url );
        response.end( 'OK' );
    }
    var createServer = httpServer( onRequest );
  • Returns a function which creates an HTTP server.

    throws

    must provide valid options

    Parameters

    • options: Options

      server options

    • Optional requestListener: RequestListener

      callback invoked upon receiving an HTTP request

    Returns createServer

    function which creates an HTTP server

    Example

    var opts = {
        'port': 7331,
        'address': '0.0.0.0'
    };
    var createServer = httpServer( opts );

    Example

    var opts = {
        'port': 7331,
        'address': '0.0.0.0'
    };
    function onRequest( request, response ) {
        console.log( request.url );
        response.end( 'OK' );
    }
    var createServer = httpServer( opts, onRequest );