tv

Interactive debug console plugin for hapi

This module is no longer being maintained
Last updated 4 years ago by osukaa .
BSD-3-Clause · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install tv 
SYNC missed versions from official npm registry.

tv Logo

TV is an interactive debug console plugin for hapi

Build Status

Lead Maintainer: Oscar A. Funes Martinez

TV is a simple web page in which developers can view server logs for their requests. Optionally, they can also filter the server logs to just their requests by attaching a unique client id to each request. The server will use WebSocket to stream the logs to the web application in real-time.

Here's what it looks like in action:

TV interactive debug console

Using TV in Your Application

To enable TV in a hapi application, install tv and register it. Below is an example of registering the tv plugin:

const Hapi = require('hapi');
const Tv = require('tv');

const server = new Hapi.Server();

server.register(Tv, (err) => {

    if (err) {
        throw err;
    }
    server.start();
});

In applications using multiple server instances, only one server can enable the debug interface using the default port.

Options

Below are the options available to be passed into the tv plugin:

  • host - the public hostname or IP address. Used only to set server.info.host and server.info.uri. Deaults to hostname and if not available to localhost(see hapi new Server()).
  • address - the hostname of IP address the WebSocket connection will bind to. Defaults to host if present otherwise 0.0.0.0(see hapi new Server()).
  • port - the port used by the WebSocket connection. Defaults to 0 and therefore an ephemeral port (see hapi new Server()).
  • endpoint - the debug console request path added to the server routes. Defaults to '/debug/console'.
  • queryKey - the name or the request query parameter used to mark requests being debugged. Defaults to debug.
  • template - the name of the template to use for the debug console. Defaults to index.
  • authenticateEndpoint - set this to true to use auth schemes for TVs main- and file delivering routes (defaults to false)

Below is an example of registering the tv plugin with some options:

const Hapi = require('hapi');
const Tv = require('tv');
const options = { endpoint: '/awesome' };

const server = new Hapi.Server();

server.register({ register: Tv, options: options }, function (err) {
    ...
});

Current Tags

  • 6.1.0                                ...           latest (4 years ago)

29 Versions

  • 6.1.0 [deprecated]           ...           4 years ago
  • 6.0.0 [deprecated]           ...           4 years ago
  • 5.0.2 [deprecated]           ...           5 years ago
  • 5.0.1 [deprecated]           ...           5 years ago
  • 5.0.0 [deprecated]           ...           5 years ago
  • 4.1.1 [deprecated]           ...           5 years ago
  • 4.1.0 [deprecated]           ...           6 years ago
  • 4.0.0 [deprecated]           ...           6 years ago
  • 3.0.0 [deprecated]           ...           6 years ago
  • 2.1.0 [deprecated]           ...           6 years ago
  • 2.0.0 [deprecated]           ...           6 years ago
  • 1.2.0 [deprecated]           ...           6 years ago
  • 1.1.1 [deprecated]           ...           7 years ago
  • 1.1.0 [deprecated]           ...           7 years ago
  • 1.0.1 [deprecated]           ...           7 years ago
  • 1.0.0 [deprecated]           ...           7 years ago
  • 0.5.1 [deprecated]           ...           7 years ago
  • 0.5.0 [deprecated]           ...           7 years ago
  • 0.4.0 [deprecated]           ...           7 years ago
  • 0.3.2 [deprecated]           ...           7 years ago
  • 0.3.1 [deprecated]           ...           7 years ago
  • 0.3.0 [deprecated]           ...           7 years ago
  • 0.2.0 [deprecated]           ...           8 years ago
  • 0.1.2 [deprecated]           ...           8 years ago
  • 0.1.1 [deprecated]           ...           8 years ago
  • 0.1.0 [deprecated]           ...           8 years ago
  • 0.0.3 [deprecated]           ...           8 years ago
  • 0.0.2 [deprecated]           ...           8 years ago
  • 0.0.1 [deprecated]           ...           8 years ago
Downloads
Today 0
This Week 0
This Month 1
Last Day 0
Last Week 0
Last Month 1
Dependencies (12)
Dev Dependencies (21)

Copyright 2014 - 2016 © taobao.org |