// Copyright 2012 Mark Cavage, Inc. All rights reserved. 'use strict'; var assert = require('assert-plus'); var errors = require('restify-errors'); var bunyan = require('./bunyan_helper'); var Router = require('./router'); var Server = require('./server'); var shallowCopy = require('./utils').shallowCopy; var InternalError = errors.InternalError; /** * A restify server object is the main interface through which you will register * routes and handlers for incoming requests. * * @public * @function createServer * @param {Object} [options] - an options object * @param {String} [options.name="restify"] - Name of the server. * @param {Boolean} [options.dtrace=false] - enable DTrace support * @param {Router} [options.router=new Router(opts)] - Router * @param {Object} [options.log=bunyan.createLogger(options.name || "restify")] * - [bunyan](https://github.com/trentm/node-bunyan) instance. * @param {String} [options.url] - Once listen() is called, this will be filled * in with where the server is running. * @param {String|Buffer} [options.certificate] - If you want to create an HTTPS * server, pass in a PEM-encoded certificate and key. * @param {String|Buffer} [options.key] - If you want to create an HTTPS server, * pass in a PEM-encoded certificate and key. * @param {Object} [options.formatters] - Custom response formatters for * `res.send()`. * @param {Boolean} [options.handleUncaughtExceptions=false] - When true restify * will use a domain to catch and respond to any uncaught * exceptions that occur in it's handler stack. * [bunyan](https://github.com/trentm/node-bunyan) instance. * response header, default is `restify`. Pass empty string to unset the header. * Comes with significant negative performance impact. * @param {Object} [options.spdy] - Any options accepted by * [node-spdy](https://github.com/indutny/node-spdy). * @param {Object} [options.http2] - Any options accepted by * [http2.createSecureServer](https://nodejs.org/api/http2.html). * @param {Boolean} [options.handleUpgrades=false] - Hook the `upgrade` event * from the node HTTP server, pushing `Connection: Upgrade` requests through the * regular request handling chain. * @param {Boolean} [options.onceNext=false] - Prevents calling next multiple * times * @param {Boolean} [options.strictNext=false] - Throws error when next() is * called more than once, enabled onceNext option * @param {Object} [options.httpsServerOptions] - Any options accepted by * [node-https Server](http://nodejs.org/api/https.html#https_https). * If provided the following restify server options will be ignored: * spdy, ca, certificate, key, passphrase, rejectUnauthorized, requestCert and * ciphers; however these can all be specified on httpsServerOptions. * @param {Boolean} [options.noWriteContinue=false] - prevents * `res.writeContinue()` in `server.on('checkContinue')` when proxing * @param {Boolean} [options.ignoreTrailingSlash=false] - ignore trailing slash * on paths * @param {Boolean} [options.strictFormatters=true] - enables strict formatters * behavior: a formatter matching the response's content-type is required. If * not found, the response's content-type is automatically set to * 'application/octet-stream'. If a formatter for that content-type is not * found, sending the response errors. * @example * var restify = require('restify'); * var server = restify.createServer(); * * server.listen(8080, function () { * console.log('ready on %s', server.url); * }); * @returns {Server} server */ function createServer(options) { assert.optionalObject(options, 'options'); var opts = shallowCopy(options || {}); var server; // empty string should override default value. opts.name = opts.hasOwnProperty('name') ? opts.name : 'restify'; opts.log = opts.log || bunyan.createLogger(opts.name || 'restify'); opts.router = opts.router || new Router(opts); server = new Server(opts); if (opts.handleUncaughtExceptions) { server.on('uncaughtException', function onUncaughtException( req, res, route, e ) { if ( this.listeners('uncaughtException').length > 1 || res.headersSent ) { return false; } res.send(new InternalError(e, e.message || 'unexpected error')); return true; }); } return server; } ///--- Exports module.exports.bunyan = bunyan; module.exports.createServer = createServer; module.exports.formatters = require('./formatters'); module.exports.plugins = require('./plugins'); module.exports.pre = require('./plugins').pre; module.exports.helpers = { compose: require('./helpers/chainComposer') };