api documentation for foreman (v2.0.0)

Node Implementation of Foreman

table of contents

  1. module foreman
    1. object foreman.colors
    2. object foreman.envs
    3. object foreman.proc
    4. object foreman.procfile
    5. object foreman.requirements
  2. module foreman.colors
    1. function foreman.colors.blue (str)
    2. function foreman.colors.bright_blue (str)
    3. function foreman.colors.bright_cyan (str)
    4. function foreman.colors.bright_green (str)
    5. function foreman.colors.bright_magenta (str)
    6. function foreman.colors.bright_red (str)
    7. function foreman.colors.bright_yellow (str)
    8. function foreman.colors.cyan (str)
    9. function foreman.colors.green (str)
    10. function foreman.colors.magenta (str)
    11. function foreman.colors.red (str)
    12. function foreman.colors.yellow (str)
    13. number foreman.colors.colors_max
    14. object foreman.colors
  3. module foreman.envs
    1. function foreman.envs.dumpEnv (conf)
    2. function foreman.envs.flattenJSON (json)
    3. function foreman.envs.keyValue (data)
    4. function foreman.envs.loadEnvs (path)
  4. module foreman.proc
    1. function foreman.proc.once (input, envs, callback)
    2. function foreman.proc.run (key, proc, emitter)
    3. function foreman.proc.start (procs, requirements, envs, portarg, emitter)
  5. module foreman.procfile
    1. function foreman.procfile.loadProc (filename)
    2. function foreman.procfile.procs (procdata)
  6. module foreman.requirements
    1. function foreman.requirements.calculatePadding (reqs)
    2. function foreman.requirements.getreqs (args, proc)

module foreman

module foreman.colors

function foreman.colors.blue (str)

function foreman.colors.bright_blue (str)

function foreman.colors.bright_cyan (str)

function foreman.colors.bright_green (str)

function foreman.colors.bright_magenta (str)

function foreman.colors.bright_red (str)

function foreman.colors.bright_yellow (str)

function foreman.colors.cyan (str)

function foreman.colors.green (str)

function foreman.colors.magenta (str)

function foreman.colors.red (str)

function foreman.colors.yellow (str)

module foreman.envs

function foreman.envs.dumpEnv (conf)

function foreman.envs.flattenJSON (json)

function foreman.envs.keyValue (data)

function foreman.envs.loadEnvs (path)

module foreman.proc

function foreman.proc.once (input, envs, callback)

function foreman.proc.run (key, proc, emitter)

function foreman.proc.start (procs, requirements, envs, portarg, emitter)

module foreman.procfile

function foreman.procfile.loadProc (filename)

function foreman.procfile.procs (procdata)

module foreman.requirements

function foreman.requirements.calculatePadding (reqs)

function foreman.requirements.getreqs (args, proc)

[ this document was created with utility2 ]