Parch

  • API Docs for Version: 2.1.2

    • Show:

    Application

    Module: parch

    Base application

    Table of Contents

    Constructor

    Application
    (
    • options
    )

    Defined in src/application.js:21

    Parameters:

    Methods

    _configure
    (
    • config
    )
    Object
    private

    Defined in src/application.js:139

    Normalizes constructor options

    Parameters:

    • config Object

      user passed config options

    Returns:

    Object:

    final config option

    _getProjectDirectory () String
    private

    Defined in src/application.js:165

    Returns the project directory (cwd) from which Application is being instantiated

    Returns:

    String:

    directory

    _initialize
    (
    • name
    )
    private

    Defined in src/application.js:179

    Run an initializer by name

    Parameters:

    listen
    (
    • port
    )
    Promise

    Defined in src/application.js:75

    Starts the server

    Parameters:

    Returns:

    Promise
    runProjectInitializers () Promise

    Defined in src/application.js:97

    Runs all consumer initializers

    Returns:

    Promise
    start
    (
    • port
    )
    Promise

    Defined in src/application.js:128

    starts listening on the defined port

    Parameters:

    • port Number

      the port to listen on. Default: 3000

    Returns:

    Promise

    Properties

    app

    Object Restify service

    Defined in src/application.js:65

    Restify application instance

    projectDirectory

    String

    Defined in src/application.js:87

    The consuming project's directory