1. module static-server
   1. function static-server (options)
   2. function static-server.server (options)
   3. function static-server.super_ ()
   4. object static-server.STATUS_CODES
   5. object static-server.server.prototype
2. module static-server.server
   1. function static-server.server (options)
   2. function static-server.server.super_ ()
   3. object static-server.server.STATUS_CODES
3. module static-server.server.prototype
   1. function static-server.server.prototype.start (callback)
   2. function static-server.server.prototype.stop ()

module static-server

function static-server (options)

• description and source-code

  function StaticServer(options) {
    options = options || {};
  
    if (!options.rootPath) {
      throw new Error('Root path not specified');
    }
  
    if(!options.templates){
      options.templates = {};
    }
  
    this.name = options.name;
    this.host = options.host;
    this.port = options.port;
    this.cors = options.cors;
    this.rootPath = path.resolve(options.rootPath);
    this.followSymlink = !!options.followSymlink;
    this.templates = {
      'index': (options.templates.index || DEFAULT_INDEX),
      'notFound': options.templates.notFound
    };
  
    if (options.index) {
      console.log("options.index is now deprecated please use options.templates.index instead.");
      this.templates.index = options.index;
    }
  
    Object.defineProperty(this, '_socket', {
      configurable: true,
      enumerable: false,
      writable: true,
      value: null
    });
  
  }

• example usage

  n/a

function static-server.server (options)

• description and source-code

  function StaticServer(options) {
    options = options || {};
  
    if (!options.rootPath) {
      throw new Error('Root path not specified');
    }
  
    if(!options.templates){
      options.templates = {};
    }
  
    this.name = options.name;
    this.host = options.host;
    this.port = options.port;
    this.cors = options.cors;
    this.rootPath = path.resolve(options.rootPath);
    this.followSymlink = !!options.followSymlink;
    this.templates = {
      'index': (options.templates.index || DEFAULT_INDEX),
      'notFound': options.templates.notFound
    };
  
    if (options.index) {
      console.log("options.index is now deprecated please use options.templates.index instead.");
      this.templates.index = options.index;
    }
  
    Object.defineProperty(this, '_socket', {
      configurable: true,
      enumerable: false,
      writable: true,
      value: null
    });
  
  }

• example usage

  n/a

function static-server.super_ ()

• description and source-code

  function EventEmitter() {
    EventEmitter.init.call(this);
  }

• example usage

  n/a

module static-server.server

function static-server.server (options)

• description and source-code

  function StaticServer(options) {
    options = options || {};
  
    if (!options.rootPath) {
      throw new Error('Root path not specified');
    }
  
    if(!options.templates){
      options.templates = {};
    }
  
    this.name = options.name;
    this.host = options.host;
    this.port = options.port;
    this.cors = options.cors;
    this.rootPath = path.resolve(options.rootPath);
    this.followSymlink = !!options.followSymlink;
    this.templates = {
      'index': (options.templates.index || DEFAULT_INDEX),
      'notFound': options.templates.notFound
    };
  
    if (options.index) {
      console.log("options.index is now deprecated please use options.templates.index instead.");
      this.templates.index = options.index;
    }
  
    Object.defineProperty(this, '_socket', {
      configurable: true,
      enumerable: false,
      writable: true,
      value: null
    });
  
  }

• example usage

  n/a

function static-server.server.super_ ()

• description and source-code

  function EventEmitter() {
    EventEmitter.init.call(this);
  }

• example usage

  n/a

module static-server.server.prototype

function static-server.server.prototype.start (callback)

• description and source-code

  function start(callback) {
    this._socket = http.createServer(requestHandler(this)).listen(this.port, this.host, callback);
  }

• example usage

  ...
    followSymlink: true,      // optional, defaults to a 404 error
    templates: {
      index: 'foo.html',      // optional, defaults to 'index.html'
      notFound: '404.html'    // optional, defaults to undefined
    }
  });
  
  server.start(function () {
    console.log('Server listening to', server.port);
  });
  
  server.on('request', function (req, res) {
    // req.path is the URL resource (file name) from server.rootPath
    // req.elapsedTime returns a string of the request's elapsed time
  });
  ...

function static-server.server.prototype.stop ()

• description and source-code

  function stop() {
    if (this._socket) {
      this._socket.close();
      this._socket = null;
    }
  }

• example usage

  n/a