Skip to content

Instantly share code, notes, and snippets.

@rrrene
Created October 29, 2015 13:23
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save rrrene/69c0a81bc748d6fd71a5 to your computer and use it in GitHub Desktop.
Save rrrene/69c0a81bc748d6fd71a5 to your computer and use it in GitHub Desktop.
{
"args": [],
"branch_name": "master",
"client_name": "inchjs",
"client_version": "0.4.0",
"git_repo_url": "https://github.com/foreverjs/forever.git",
"language": "javascript",
"objects": [
{
"comment": "//\n// ### @private function (file, options, callback)\n// #### @file {string} Target script to start\n// #### @options {Object} Options to start the script with\n// #### @callback {function} Continuation to respond to when complete.\n// Helper function that sets up the pathing for the specified `file`\n// then stats the appropriate files and responds.\n//",
"kind": "function",
"longname": "tryStart",
"meta": {
"code": {
"id": "astnode100000267",
"name": "tryStart",
"paramnames": [
"file",
"options",
"callback"
],
"type": "FunctionDeclaration"
},
"filename": "cli.js",
"lineno": 143,
"path": "/lib/forever",
"range": [
5582,
6101
],
"vars": {
"": null,
"forever.root": "forever.root",
"fullLog": "tryStart~fullLog",
"fullScript": "tryStart~fullScript"
}
},
"name": "tryStart",
"scope": "global",
"undocumented": true
},
{
"comment": "//\n// ### @private function updateConfig (updater)\n// #### @updater {function} Function which updates the forever config\n// Helper which runs the specified `updater` and then saves the forever\n// config to `forever.config.get('root')`.\n//",
"kind": "function",
"longname": "updateConfig",
"meta": {
"code": {
"id": "astnode100000370",
"name": "updateConfig",
"paramnames": [
"updater"
],
"type": "FunctionDeclaration"
},
"filename": "cli.js",
"lineno": 171,
"path": "/lib/forever",
"range": [
6342,
6688
],
"vars": {
"": null
}
},
"name": "updateConfig",
"scope": "global",
"undocumented": true
},
{
"comment": "//\n// ### @private function checkColumn (name)\n// #### @name {string} Column to check\n// Checks if column `name` exists\n//",
"kind": "function",
"longname": "checkColumn",
"meta": {
"code": {
"id": "astnode100000434",
"name": "checkColumn",
"paramnames": [
"name"
],
"type": "FunctionDeclaration"
},
"filename": "cli.js",
"lineno": 189,
"path": "/lib/forever",
"range": [
6813,
6970
]
},
"name": "checkColumn",
"scope": "global",
"undocumented": true
},
{
"comment": "//\n// ### function getOptions (file)\n// #### @file {string} File to run. **Optional**\n// Returns `options` object for use with `forever.start` and\n// `forever.startDaemon`\n//",
"kind": "function",
"longname": "cli.getOptions",
"memberof": "cli",
"meta": {
"code": {
"id": "astnode100000465",
"name": "cli.getOptions",
"paramnames": [
"file"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "cli.js",
"lineno": 203,
"path": "/lib/forever",
"range": [
7164,
9664
],
"vars": {
"": null,
"absFile": "cli.getOptions~absFile",
"app.config.stores.argv.store": "app.config.stores.argv.store",
"configKeys": "cli.getOptions~configKeys",
"configs": "cli.getOptions~configs",
"options": "cli.getOptions~options",
"options.args": "cli.getOptions~options.args",
"options.minUptime": "cli.getOptions~options.minUptime",
"options.script": "cli.getOptions~options.script",
"options.sourceDir": "cli.getOptions~options.sourceDir",
"options.spawnWith": "cli.getOptions~options.spawnWith",
"options.watchIgnore": "cli.getOptions~options.watchIgnore",
"options.watchIgnorePatterns": "cli.getOptions~options.watchIgnorePatterns",
"options.workingDir": "cli.getOptions~options.workingDir",
"specialKeys": "cli.getOptions~specialKeys"
}
},
"name": "getOptions",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function cleanLogs\n// Deletes all historical forever log files\n//",
"kind": "function",
"longname": "cli.cleanLogs",
"memberof": "cli",
"meta": {
"code": {
"id": "astnode100000853",
"name": "cli.cleanLogs",
"paramnames": [],
"type": "FunctionExpression",
"value": "function"
},
"filename": "cli.js",
"lineno": 295,
"path": "/lib/forever",
"range": [
9764,
9979
],
"vars": {
"": null
}
},
"name": "cleanLogs",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function start (file)\n// #### @file {string} Location of the script to spawn with forever\n// Starts a forever process for the script located at `file` as daemon\n// process.\n//",
"kind": "function",
"longname": "cli.startDaemon",
"memberof": "cli",
"meta": {
"code": {
"id": "astnode100000909",
"name": "cli.startDaemon",
"paramnames": [],
"type": "FunctionExpression",
"value": "function"
},
"filename": "cli.js",
"lineno": 308,
"path": "/lib/forever",
"range": [
10191,
10482
],
"vars": {
"": null,
"file": "cli.startDaemon~file",
"options": "cli.startDaemon~options"
}
},
"name": "startDaemon",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function stop (file)\n// #### @file {string} Target forever process to stop\n// Stops the forever process specified by `file`.\n//",
"kind": "function",
"longname": "cli.stop",
"memberof": "cli",
"meta": {
"code": {
"id": "astnode100000976",
"name": "cli.stop",
"paramnames": [
"file"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "cli.js",
"lineno": 326,
"path": "/lib/forever",
"range": [
10645,
10968
],
"vars": {
"": null,
"runner": "cli.stop~runner"
}
},
"name": "stop",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function stopbypid (pid)\n// Stops running forever process by pid.\n//",
"kind": "function",
"longname": "cli.stopbypid",
"memberof": "cli",
"meta": {
"code": {
"id": "astnode100001044",
"name": "cli.stopbypid",
"paramnames": [
"pid"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "cli.js",
"lineno": 343,
"path": "/lib/forever",
"range": [
11077,
11203
]
},
"name": "stopbypid",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function stopall ()\n// Stops all currently running forever processes.\n//",
"kind": "function",
"longname": "cli.stopall",
"memberof": "cli",
"meta": {
"code": {
"id": "astnode100001075",
"name": "cli.stopall",
"paramnames": [],
"type": "FunctionExpression",
"value": "function"
},
"filename": "cli.js",
"lineno": 352,
"path": "/lib/forever",
"range": [
11309,
11774
],
"vars": {
"": null,
"runner": "cli.stopall~runner"
}
},
"name": "stopall",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function restartall ()\n// Restarts all currently running forever processes.\n//",
"kind": "function",
"longname": "cli.restartAll",
"memberof": "cli",
"meta": {
"code": {
"id": "astnode100001160",
"name": "cli.restartAll",
"paramnames": [],
"type": "FunctionExpression",
"value": "function"
},
"filename": "cli.js",
"lineno": 375,
"path": "/lib/forever",
"range": [
11889,
12365
],
"vars": {
"": null,
"runner": "cli.restartAll~runner"
}
},
"name": "restartAll",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function restart (file)\n// #### @file {string} Target process to restart\n// Restarts the forever process specified by `file`.\n//",
"kind": "function",
"longname": "cli.restart",
"memberof": "cli",
"meta": {
"code": {
"id": "astnode100001245",
"name": "cli.restart",
"paramnames": [
"file"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "cli.js",
"lineno": 399,
"path": "/lib/forever",
"range": [
12532,
13082
],
"vars": {
"": null,
"runner": "cli.restart~runner"
}
},
"name": "restart",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function list ()\n// Lists all currently running forever processes.\n//",
"kind": "function",
"longname": "cli.list",
"memberof": "cli",
"meta": {
"code": {
"id": "astnode100001353",
"name": "cli.list",
"paramnames": [],
"type": "FunctionExpression",
"value": "function"
},
"filename": "cli.js",
"lineno": 424,
"path": "/lib/forever",
"range": [
13182,
13512
],
"vars": {
"": null
}
},
"name": "list",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function config ()\n// Lists all of the configuration in `~/.forever/config.json`.\n//",
"kind": "function",
"longname": "cli.config",
"memberof": "cli",
"meta": {
"code": {
"id": "astnode100001415",
"name": "cli.config",
"paramnames": [],
"type": "FunctionExpression",
"value": "function"
},
"filename": "cli.js",
"lineno": 442,
"path": "/lib/forever",
"range": [
13629,
14096
],
"vars": {
"": null,
"conf": "cli.config~conf",
"keys": "cli.config~keys"
}
},
"name": "config",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function set (key, value)\n// #### @key {string} Key to set in forever config\n// #### @value {string} Value to set for `key`\n// Sets the specified `key` / `value` pair in the\n// forever user config.\n//",
"kind": "function",
"longname": "cli.set",
"memberof": "cli",
"meta": {
"code": {
"id": "astnode100001511",
"name": "cli.set",
"paramnames": [
"key",
"value"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "cli.js",
"lineno": 468,
"path": "/lib/forever",
"range": [
14341,
14508
],
"vars": {
"": null
}
},
"name": "set",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function clear (key)\n// #### @key {string} Key to remove from `~/.forever/config.json`\n// Removes the specified `key` from the forever user config.\n//",
"kind": "function",
"longname": "cli.clear",
"memberof": "cli",
"meta": {
"code": {
"id": "astnode100001551",
"name": "cli.clear",
"paramnames": [
"key"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "cli.js",
"lineno": 480,
"path": "/lib/forever",
"range": [
14695,
15038
],
"vars": {
"": null
}
},
"name": "clear",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function logs (target)\n// #### @target {string} Target script or index to list logs for\n// Displays the logs using `tail` for the specified `target`.\n//",
"kind": "function",
"longname": "cli.logs",
"memberof": "cli",
"meta": {
"code": {
"id": "astnode100001624",
"name": "cli.logs",
"paramnames": [
"index"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "cli.js",
"lineno": 498,
"path": "/lib/forever",
"range": [
15228,
15544
],
"vars": {
"": null,
"options": "cli.logs~options"
}
},
"name": "logs",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function logFiles ()\n// Display log files for all running forever processes.\n//",
"kind": "function",
"longname": "cli.logFiles",
"memberof": "cli",
"meta": {
"code": {
"id": "astnode100001701",
"name": "cli.logFiles",
"paramnames": [
"index"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "cli.js",
"lineno": 518,
"path": "/lib/forever",
"range": [
15654,
16245
],
"vars": {
"": null,
"index": "cli.logFiles~index",
"rows": "cli.logFiles~rows"
}
},
"name": "logFiles",
"scope": "static",
"undocumented": true
},
{
"comment": "",
"kind": "function",
"longname": "cli.addColumn",
"memberof": "cli",
"meta": {
"code": {
"id": "astnode100001816",
"name": "cli.addColumn",
"paramnames": [
"name"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "cli.js",
"lineno": 541,
"path": "/lib/forever",
"range": [
16279,
16668
],
"vars": {
"columns": "cli.addColumn~columns"
}
},
"name": "addColumn",
"scope": "static",
"undocumented": true
},
{
"comment": "",
"kind": "function",
"longname": "cli.rmColumn",
"memberof": "cli",
"meta": {
"code": {
"id": "astnode100001898",
"name": "cli.rmColumn",
"paramnames": [
"name"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "cli.js",
"lineno": 557,
"path": "/lib/forever",
"range": [
16700,
17113
],
"vars": {
"columns": "cli.rmColumn~columns"
}
},
"name": "rmColumn",
"scope": "static",
"undocumented": true
},
{
"comment": "",
"kind": "function",
"longname": "cli.setColumns",
"memberof": "cli",
"meta": {
"code": {
"id": "astnode100001986",
"name": "cli.setColumns",
"paramnames": [
"columns"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "cli.js",
"lineno": 573,
"path": "/lib/forever",
"range": [
17145,
17326
]
},
"name": "setColumns",
"scope": "static",
"undocumented": true
},
{
"comment": "",
"kind": "function",
"longname": "cli.resetColumns",
"memberof": "cli",
"meta": {
"code": {
"id": "astnode100002031",
"name": "cli.resetColumns",
"paramnames": [],
"type": "FunctionExpression",
"value": "function"
},
"filename": "cli.js",
"lineno": 580,
"path": "/lib/forever",
"range": [
17355,
17597
],
"vars": {
"columns": "cli.resetColumns~columns"
}
},
"name": "resetColumns",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function help ()\n// Shows help\n//",
"kind": "function",
"longname": "cli.help",
"memberof": "cli",
"meta": {
"code": {
"id": "astnode100002079",
"name": "cli.help",
"paramnames": [],
"type": "FunctionExpression",
"value": "function"
},
"filename": "cli.js",
"lineno": 593,
"path": "/lib/forever",
"range": [
17661,
17717
]
},
"name": "help",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function start (file)\n// #### @file {string} Location of the script to spawn with forever\n// Starts a forever process for the script located at `file` as non-daemon\n// process.\n//\n// Remark: this regex matches everything. It has to be added at the end to\n// make executing other commands possible.\n//",
"kind": "function",
"longname": "cli.run",
"memberof": "cli",
"meta": {
"code": {
"id": "astnode100002096",
"name": "cli.run",
"paramnames": [],
"type": "FunctionExpression",
"value": "function"
},
"filename": "cli.js",
"lineno": 606,
"path": "/lib/forever",
"range": [
18032,
18343
],
"vars": {
"": null,
"file": "cli.run~file",
"options": "cli.run~options"
}
},
"name": "run",
"scope": "static",
"undocumented": true
},
{
"comment": "",
"kind": "function",
"longname": "cli.start",
"memberof": "cli",
"meta": {
"code": {
"id": "astnode100002160",
"name": "cli.start",
"paramnames": [],
"type": "FunctionExpression",
"value": "function"
},
"filename": "cli.js",
"lineno": 620,
"path": "/lib/forever",
"range": [
18346,
18860
],
"vars": {
"": null,
"colors.mode": "colors.mode"
}
},
"name": "start",
"scope": "static",
"undocumented": true
},
{
"comment": "",
"kind": "function",
"longname": "Worker",
"meta": {
"code": {
"id": "astnode100002313",
"name": "exports.Worker",
"paramnames": [
"options"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "worker.js",
"lineno": 8,
"path": "/lib/forever",
"range": [
229,
508
],
"vars": {
"options": "Worker~options",
"this._socket": "Worker#_socket",
"this.exitOnStop": "Worker#exitOnStop",
"this.monitor": "Worker#monitor",
"this.sockPath": "Worker#sockPath"
}
},
"name": "Worker",
"scope": "global",
"undocumented": true
},
{
"comment": "",
"kind": "function",
"longname": "Worker#start",
"memberof": "Worker",
"meta": {
"code": {
"id": "astnode100002384",
"name": "Worker.prototype.start",
"paramnames": [
"callback"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "worker.js",
"lineno": 21,
"path": "/lib/forever",
"range": [
557,
4193
],
"vars": {
"err": "Worker#start~err",
"findAndStart": "Worker#start~findAndStart",
"self": "Worker#start~self",
"workerProtocol": "Worker#start~workerProtocol"
}
},
"name": "start",
"scope": "instance",
"undocumented": true
},
{
"comment": "//\n// ### function getSockets (sockPath, callback)\n// #### @sockPath {string} Path in which to look for UNIX domain sockets\n// #### @callback {function} Continuation to pass control to when complete\n// Attempts to read the files from `sockPath` if the directory does not exist,\n// then it is created using `mkdirp`.\n//",
"kind": "function",
"longname": "getSockets",
"meta": {
"code": {
"id": "astnode100003084",
"name": "getSockets",
"paramnames": [
"sockPath",
"callback"
],
"type": "FunctionDeclaration"
},
"filename": "forever.js",
"lineno": 70,
"path": "/lib",
"range": [
2006,
2346
],
"vars": {
"": null,
"sockets": "getSockets~sockets"
}
},
"name": "getSockets",
"scope": "global",
"undocumented": true
},
{
"comment": "//\n// ### function getAllProcess (callback)\n// #### @callback {function} Continuation to respond to when complete.\n// Returns all data for processes managed by forever.\n//",
"kind": "function",
"longname": "getAllProcesses",
"meta": {
"code": {
"id": "astnode100003137",
"name": "getAllProcesses",
"paramnames": [
"callback"
],
"type": "FunctionDeclaration"
},
"filename": "forever.js",
"lineno": 94,
"path": "/lib",
"range": [
2520,
3596
],
"vars": {
"": null,
"getProcess": "getAllProcesses~getProcess",
"sockPath": "getAllProcesses~sockPath"
}
},
"name": "getAllProcesses",
"scope": "global",
"undocumented": true
},
{
"comment": "//\n// ### function getAllPids ()\n// Returns the set of all pids managed by forever.\n// e.x. [{ pid: 12345, foreverPid: 12346 }, ...]\n//",
"kind": "function",
"longname": "getAllPids",
"meta": {
"code": {
"id": "astnode100003307",
"name": "getAllPids",
"paramnames": [
"processes"
],
"type": "FunctionDeclaration"
},
"filename": "forever.js",
"lineno": 148,
"path": "/lib",
"range": [
3734,
3910
],
"vars": {
"": null
}
},
"name": "getAllPids",
"scope": "global",
"undocumented": true
},
{
"comment": "//\n// ### function stopOrRestart (action, event, format, target)\n// #### @action {string} Action that is to be sent to target(s).\n// #### @event {string} Event that will be emitted on success.\n// #### @format {boolean} Indicated if we should CLI format the returned output.\n// #### @target {string} Index or script name to stop. Optional.\n// #### If not provided -> action will be sent to all targets.\n// Returns emitter that you can use to handle events on failure or success (i.e 'error' or <event>)\n//",
"kind": "function",
"longname": "stopOrRestart",
"meta": {
"code": {
"id": "astnode100003333",
"name": "stopOrRestart",
"paramnames": [
"action",
"event",
"format",
"target"
],
"type": "FunctionDeclaration"
},
"filename": "forever.js",
"lineno": 166,
"path": "/lib",
"range": [
4434,
7105
],
"vars": {
"": null,
"emitter": "stopOrRestart~emitter",
"sendAction": "stopOrRestart~sendAction"
}
},
"name": "stopOrRestart",
"scope": "global",
"undocumented": true
},
{
"comment": "//\n// ### function load (options, [callback])\n// #### @options {Object} Options to load into the forever module\n// Initializes configuration for forever module\n//",
"kind": "function",
"longname": "forever.load",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100003632",
"name": "forever.load",
"paramnames": [
"options"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 268,
"path": "/lib",
"range": [
7270,
9987
],
"vars": {
"forever.config": "forever.config",
"forever.initialized": "forever.initialized",
"forever.out.transports.console.timestamp": "forever.out.transports.console.timestamp",
"options": "forever.load~options",
"options.columns": "forever.load~options.columns",
"options.debug": "forever.load~options.debug",
"options.loglength": "forever.load~options.loglength",
"options.logstream": "forever.load~options.logstream",
"options.pidPath": "forever.load~options.pidPath",
"options.root": "forever.load~options.root",
"options.sockPath": "forever.load~options.sockPath",
"this._loadedOptions": "forever.load#_loadedOptions",
"tryCreate": "forever.load~tryCreate"
}
},
"name": "load",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### @private function _debug ()\n// Sets up debugging for this forever process\n//",
"kind": "function",
"longname": "forever._debug",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100003987",
"name": "forever._debug",
"paramnames": [],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 370,
"path": "/lib",
"range": [
10077,
10364
],
"vars": {
"debug": "forever._debug~debug"
}
},
"name": "_debug",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function stat (logFile, script, callback)\n// #### @logFile {string} Path to the log file for this script\n// #### @logAppend {boolean} Optional. True Prevent failure if the log file exists.\n// #### @script {string} Path to the target script.\n// #### @callback {function} Continuation to pass control back to\n// Ensures that the logFile doesn't exist and that\n// the target script does exist before executing callback.\n//",
"kind": "function",
"longname": "forever.stat",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100004050",
"name": "forever.stat",
"paramnames": [
"logFile",
"script",
"callback"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 396,
"path": "/lib",
"range": [
10891,
11445
],
"vars": {
"": null,
"callback": "forever.stat~callback",
"logAppend": "forever.stat~logAppend"
}
},
"name": "stat",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function start (script, options)\n// #### @script {string} Location of the script to run.\n// #### @options {Object} Configuration for forever instance.\n// Starts a script with forever\n//",
"kind": "function",
"longname": "forever.start",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100004134",
"name": "forever.start",
"paramnames": [
"script",
"options"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 423,
"path": "/lib",
"range": [
11644,
12042
],
"vars": {
"monitor": "forever.start~monitor",
"options.logFile": "options.logFile",
"options.uid": "options.uid"
}
},
"name": "start",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function startDaemon (script, options)\n// #### @script {string} Location of the script to run.\n// #### @options {Object} Configuration for forever instance.\n// Starts a script with forever as a daemon\n//",
"kind": "function",
"longname": "forever.startDaemon",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100004204",
"name": "forever.startDaemon",
"paramnames": [
"script",
"options"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 446,
"path": "/lib",
"range": [
12259,
13863
],
"vars": {
"": null,
"errFD": "forever.startDaemon~errFD",
"monitor": "forever.startDaemon~monitor",
"monitorPath": "forever.startDaemon~monitorPath",
"options": "forever.startDaemon~options",
"options._loadedOptions": "forever.startDaemon~options._loadedOptions",
"options.logFile": "forever.startDaemon~options.logFile",
"options.pidFile": "forever.startDaemon~options.pidFile",
"options.uid": "forever.startDaemon~options.uid",
"outFD": "forever.startDaemon~outFD"
}
},
"name": "startDaemon",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function startServer ()\n// #### @arguments {forever.Monitor...} A list of forever.Monitor instances\n// Starts the `forever` HTTP server for communication with the forever CLI.\n// **NOTE:** This will change your `process.title`.\n//",
"kind": "function",
"longname": "forever.startServer",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100004397",
"name": "forever.startServer",
"paramnames": [],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 496,
"path": "/lib",
"range": [
14107,
14877
],
"vars": {
"": null,
"args": "forever.startServer~args",
"callback": "forever.startServer~callback",
"monitors": "forever.startServer~monitors"
}
},
"name": "startServer",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function stop (target, [format])\n// #### @target {string} Index or script name to stop\n// #### @format {boolean} Indicated if we should CLI format the returned output.\n// Stops the process(es) with the specified index or script name\n// in the list of all processes\n//",
"kind": "function",
"longname": "forever.stop",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100004531",
"name": "forever.stop",
"paramnames": [
"target",
"format"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 536,
"path": "/lib",
"range": [
15159,
15259
]
},
"name": "stop",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function restart (target, format)\n// #### @target {string} Index or script name to restart\n// #### @format {boolean} Indicated if we should CLI format the returned output.\n// Restarts the process(es) with the specified index or script name\n// in the list of all processes\n//",
"kind": "function",
"longname": "forever.restart",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100004547",
"name": "forever.restart",
"paramnames": [
"target",
"format"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 547,
"path": "/lib",
"range": [
15547,
15656
]
},
"name": "restart",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function stopbypid (target, format)\n// #### @pid {string} Pid of process to stop.\n// #### @format {boolean} Indicated if we should CLI format the returned output.\n// Stops the process with specified pid\n//",
"kind": "function",
"longname": "forever.stopbypid",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100004563",
"name": "forever.stopbypid",
"paramnames": [
"pid",
"format"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 557,
"path": "/lib",
"range": [
15875,
16038
]
},
"name": "stopbypid",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function restartAll (format)\n// #### @format {boolean} Value indicating if we should format output\n// Restarts all processes managed by forever.\n//",
"kind": "function",
"longname": "forever.restartAll",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100004579",
"name": "forever.restartAll",
"paramnames": [
"format"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 567,
"path": "/lib",
"range": [
16199,
16298
]
},
"name": "restartAll",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function stopAll (format)\n// #### @format {boolean} Value indicating if we should format output\n// Stops all processes managed by forever.\n//",
"kind": "function",
"longname": "forever.stopAll",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100004593",
"name": "forever.stopAll",
"paramnames": [
"format"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 576,
"path": "/lib",
"range": [
16453,
16543
]
},
"name": "stopAll",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function list (format, procs, callback)\n// #### @format {boolean} If set, will return a formatted string of data\n// #### @callback {function} Continuation to respond to when complete.\n// Returns the list of all process data managed by forever.\n//",
"kind": "function",
"longname": "forever.list",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100004607",
"name": "forever.list",
"paramnames": [
"format",
"callback"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 586,
"path": "/lib",
"range": [
16803,
16955
],
"vars": {
"": null
}
},
"name": "list",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function tail (target, length, callback)\n// #### @target {string} Target script to list logs for\n// #### @options {length|stream} **Optional** Length of the logs to tail, boolean stream\n// #### @callback {function} Continuation to respond to when complete.\n// Responds with the latest `length` logs for the specified `target` process\n// managed by forever. If no `length` is supplied then `forever.config.get('loglength`)`\n// is used.\n//",
"kind": "function",
"longname": "forever.tail",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100004633",
"name": "forever.tail",
"paramnames": [
"target",
"options",
"callback"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 601,
"path": "/lib",
"range": [
17406,
19465
],
"vars": {
"": null,
"args": "forever.tail~args",
"blanks": "forever.tail~blanks",
"callback": "forever.tail~callback",
"length": "forever.tail~length",
"logs": "forever.tail~logs",
"options.length": "options.length",
"options.stream": "options.stream",
"stream": "forever.tail~stream",
"tailProcess": "forever.tail~tailProcess",
"that": "forever.tail~that",
"title": "forever.tail~title"
}
},
"name": "tail",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function findById (id, processes)\n// #### @id {string} id of the process to find.\n// #### @processes {Array} Set of processes to find in.\n// Finds the process with the specified index.\n//",
"kind": "function",
"longname": "forever.findById",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100005009",
"name": "forever.findById",
"paramnames": [
"id",
"processes"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 688,
"path": "/lib",
"range": [
19666,
19886
],
"vars": {
"": null,
"procs": "forever.findById~procs"
}
},
"name": "findById",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function findByIndex (index, processes)\n// #### @index {string} Index of the process to find.\n// #### @processes {Array} Set of processes to find in.\n// Finds the process with the specified index.\n//",
"kind": "function",
"longname": "forever.findByIndex",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100005053",
"name": "forever.findByIndex",
"paramnames": [
"index",
"processes"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 705,
"path": "/lib",
"range": [
20099,
20316
],
"vars": {
"indexAsNum": "forever.findByIndex~indexAsNum",
"proc": "forever.findByIndex~proc"
}
},
"name": "findByIndex",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function findByScript (script, processes)\n// #### @script {string} The name of the script to find.\n// #### @processes {Array} Set of processes to find in.\n// Finds the process with the specified script name.\n//",
"kind": "function",
"longname": "forever.findByScript",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100005090",
"name": "forever.findByScript",
"paramnames": [
"script",
"processes"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 721,
"path": "/lib",
"range": [
20540,
20939
],
"vars": {
"": null,
"procs": "forever.findByScript~procs",
"script": "forever.findByScript~script"
}
},
"name": "findByScript",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function findByUid (uid, processes)\n// #### @uid {string} The uid of the process to find.\n// #### @processes {Array} Set of processes to find in.\n// Finds the process with the specified uid.\n//",
"kind": "function",
"longname": "forever.findByUid",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100005170",
"name": "forever.findByUid",
"paramnames": [
"script",
"processes"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 743,
"path": "/lib",
"range": [
21146,
21381
],
"vars": {
"": null,
"procs": "forever.findByUid~procs"
}
},
"name": "findByUid",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function findByPid (pid, processes)\n// #### @pid {string} The pid of the process to find.\n// #### @processes {Array} Set of processes to find in.\n// Finds the process with the specified pid.\n//",
"kind": "function",
"longname": "forever.findByPid",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100005214",
"name": "forever.findByPid",
"paramnames": [
"pid",
"processes"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 760,
"path": "/lib",
"range": [
21588,
21874
],
"vars": {
"": null,
"pid": "forever.findByPid~pid",
"procs": "forever.findByPid~procs"
}
},
"name": "findByPid",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function format (format, procs)\n// #### @format {Boolean} Value indicating if processes should be formatted\n// #### @procs {Array} Processes to format\n// Returns a formatted version of the `procs` supplied based on the column\n// configuration in `forever.config`.\n//",
"kind": "function",
"longname": "forever.format",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100005271",
"name": "forever.format",
"paramnames": [
"format",
"procs"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 780,
"path": "/lib",
"range": [
22154,
23059
],
"vars": {
"": null,
"columns": "forever.format~columns",
"formatted": "forever.format~formatted",
"index": "forever.format~index",
"mapColumns": "forever.format~mapColumns",
"rows": "forever.format~rows"
}
},
"name": "format",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function cleanUp ()\n// Utility function for removing excess pid and\n// config, and log files used by forever.\n//",
"kind": "function",
"longname": "forever.cleanUp",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100005412",
"name": "forever.cleanUp",
"paramnames": [
"cleanLogs",
"allowManager"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 824,
"path": "/lib",
"range": [
23185,
25335
],
"vars": {
"": null,
"emitter": "forever.cleanUp~emitter",
"pidPath": "forever.cleanUp~pidPath"
}
},
"name": "cleanUp",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function cleanLogsSync (processes)\n// #### @processes {Array} The set of all forever processes\n// Removes all log files from the root forever directory\n// that do not belong to current running forever processes.\n//",
"kind": "function",
"longname": "forever.cleanLogsSync",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100005689",
"name": "forever.cleanLogsSync",
"paramnames": [
"processes"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 914,
"path": "/lib",
"range": [
25563,
26089
],
"vars": {
"": null,
"files": "forever.cleanLogsSync~files",
"root": "forever.cleanLogsSync~root",
"running": "forever.cleanLogsSync~running",
"runningLogs": "forever.cleanLogsSync~runningLogs"
}
},
"name": "cleanLogsSync",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function logFilePath (logFile)\n// #### @logFile {string} Log file path\n// Determines the full logfile path name\n//",
"kind": "function",
"longname": "forever.logFilePath",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100005797",
"name": "forever.logFilePath",
"paramnames": [
"logFile",
"uid"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 940,
"path": "/lib",
"range": [
26217,
26428
]
},
"name": "logFilePath",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### function pidFilePath (pidFile)\n// #### @logFile {string} Pid file path\n// Determines the full pid file path name\n//",
"kind": "function",
"longname": "forever.pidFilePath",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100005840",
"name": "forever.pidFilePath",
"paramnames": [
"pidFile"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 951,
"path": "/lib",
"range": [
26557,
26735
]
},
"name": "pidFilePath",
"scope": "static",
"undocumented": true
},
{
"comment": "//\n// ### @function logEvents (monitor)\n// #### @monitor {forever.Monitor} Monitor to log events for\n// Logs important restart and error events to `console.error`\n//",
"kind": "function",
"longname": "forever.logEvents",
"memberof": "forever",
"meta": {
"code": {
"id": "astnode100005876",
"name": "forever.logEvents",
"paramnames": [
"monitor"
],
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 962,
"path": "/lib",
"range": [
26904,
27562
],
"vars": {
"": null
}
},
"name": "logEvents",
"scope": "static",
"undocumented": true
},
{
"comment": "",
"kind": "function",
"longname": "forever.columns.uid.get",
"memberof": "forever.columns.uid",
"meta": {
"code": {
"id": "astnode100005996",
"name": "get",
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 991,
"path": "/lib",
"range": [
27761,
27812
]
},
"name": "get",
"scope": "static",
"undocumented": true
},
{
"comment": "",
"kind": "function",
"longname": "forever.columns.id.get",
"memberof": "forever.columns.id",
"meta": {
"code": {
"id": "astnode100006008",
"name": "get",
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 997,
"path": "/lib",
"range": [
27850,
27915
]
},
"name": "get",
"scope": "static",
"undocumented": true
},
{
"comment": "",
"kind": "function",
"longname": "forever.columns.command.get",
"memberof": "forever.columns.command",
"meta": {
"code": {
"id": "astnode100006025",
"name": "get",
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 1003,
"path": "/lib",
"range": [
27957,
28029
]
},
"name": "get",
"scope": "static",
"undocumented": true
},
{
"comment": "",
"kind": "function",
"longname": "forever.columns.script.get",
"memberof": "forever.columns.script",
"meta": {
"code": {
"id": "astnode100006041",
"name": "get",
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 1009,
"path": "/lib",
"range": [
28070,
28157
]
},
"name": "get",
"scope": "static",
"undocumented": true
},
{
"comment": "",
"kind": "function",
"longname": "forever.columns.forever.get",
"memberof": "forever.columns.forever",
"meta": {
"code": {
"id": "astnode100006066",
"name": "get",
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 1015,
"path": "/lib",
"range": [
28200,
28258
]
},
"name": "get",
"scope": "static",
"undocumented": true
},
{
"comment": "",
"kind": "function",
"longname": "forever.columns.pid.get",
"memberof": "forever.columns.pid",
"meta": {
"code": {
"id": "astnode100006078",
"name": "get",
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 1021,
"path": "/lib",
"range": [
28297,
28348
]
},
"name": "get",
"scope": "static",
"undocumented": true
},
{
"comment": "",
"kind": "function",
"longname": "forever.columns.logfile.get",
"memberof": "forever.columns.logfile",
"meta": {
"code": {
"id": "astnode100006090",
"name": "get",
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 1027,
"path": "/lib",
"range": [
28393,
28476
]
},
"name": "get",
"scope": "static",
"undocumented": true
},
{
"comment": "",
"kind": "function",
"longname": "forever.columns.dir.get",
"memberof": "forever.columns.dir",
"meta": {
"code": {
"id": "astnode100006109",
"name": "get",
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 1033,
"path": "/lib",
"range": [
28514,
28576
]
},
"name": "get",
"scope": "static",
"undocumented": true
},
{
"comment": "",
"kind": "function",
"longname": "forever.columns.uptime.get",
"memberof": "forever.columns.uptime",
"meta": {
"code": {
"id": "astnode100006123",
"name": "get",
"type": "FunctionExpression",
"value": "function"
},
"filename": "forever.js",
"lineno": 1039,
"path": "/lib",
"range": [
28619,
28763
]
},
"name": "get",
"scope": "static",
"undocumented": true
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment