terminal-lab/wetty/docs/README.md

Docs

• AtoZ
• Running as daemon
• HTTPS Support
  • Using NGINX
  • Using Apache
• Automatic Login
• Downloading Files
• Development Docs

API

For WeTTY options and event details please refer to the api docs

Getting started

WeTTY is event driven. To Spawn a new server call wetty.start() with no arguments.

import { start } from 'wetty';

start(/* server settings, see Options */)
  .then((wetty) => {
    console.log('server running');
    wetty
      .on('exit', ({ code, msg }) => {
        console.log(`Exit with code: ${code} ${msg}`);
      })
      .on('spawn', (msg) => console.log(msg));
    /* code you want to execute */
  })
  .catch((err) => {
    console.error(err);
  });