kylefang/probot.github.io
1
0
Fork 0
mirror of https://github.com/zhigang1992/probot.github.io.git synced 2026-01-12 17:33:05 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update docs for v7.0.0-typescript.4

Browse Source
This commit is contained in:
tcbyrd
2018-06-07 21:35:45 -04:00
parent 2dedc5e63f
commit 4c334664b0
6 changed files with 1342 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

319
api/7.0.0-typescript.4/application.js.html Normal file
View File

@@ -0,0 +1,319 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>application.js - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#Application">Application</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#Context">Context</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#get">get</a></span></li>
</nav>
<div id="main">
<h1 class="page-title">application.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>"use strict";
var __awaiter = (this &amp;&amp; this.__awaiter) || function (thisArg, _arguments, P, generator) {
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this &amp;&amp; this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] &amp; 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" &amp;&amp; (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y &amp;&amp; (t = y[op[0] &amp; 2 ? "return" : op[0] ? "throw" : "next"]) &amp;&amp; !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [0, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 &amp;&amp; t[t.length - 1]) &amp;&amp; (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 &amp;&amp; (!t || (op[1] > t[0] &amp;&amp; op[1] &lt; t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 &amp;&amp; _.label &lt; t[1]) { _.label = t[1]; t = op; break; }
if (t &amp;&amp; _.label &lt; t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] &amp; 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
var express = require("express");
var promise_events_1 = require("promise-events");
var context_1 = require("./context");
var github_1 = require("./github");
var logger_1 = require("./logger");
var wrap_logger_1 = require("./wrap-logger");
// Some events can't get an authenticated client (#382):
function isUnauthenticatedEvent(context) {
return !context.payload.installation ||
(context.event === 'installation' &amp;&amp; context.payload.action === 'deleted');
}
/**
* The `app` parameter available to apps
*
* @property {logger} log - A logger
*/
var Application = /** @class */ (function () {
function Application(options) {
var opts = options || {};
this.events = new promise_events_1.EventEmitter();
this.log = wrap_logger_1.wrapLogger(logger_1.logger, logger_1.logger);
this.app = opts.app;
this.cache = opts.cache;
this.catchErrors = opts.catchErrors;
this.router = opts.router || express.Router(); // you can do this?
}
Application.prototype.receive = function (event) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, Promise.all([
this.events.emit('*', event),
this.events.emit(event.event, event),
this.events.emit(event.event + "." + event.payload.action, event),
])];
});
});
};
/**
* Get an {@link http://expressjs.com|express} router that can be used to
* expose HTTP endpoints
*
* @example
* module.exports = app => {
* // Get an express router to expose new HTTP endpoints
* const route = app.route('/my-app');
*
* // Use any middleware
* route.use(require('express').static(__dirname + '/public'));
*
* // Add a new route
* route.get('/hello-world', (req, res) => {
* res.end('Hello World');
* });
* };
*
* @param {string} path - the prefix for the routes
* @returns {@link http://expressjs.com/en/4x/api.html#router|express.Router}
*/
Application.prototype.route = function (path) {
if (path) {
var router = express.Router();
this.router.use(path, router);
return router;
}
else {
return this.router;
}
};
/**
* Listen for [GitHub webhooks](https://developer.github.com/webhooks/),
* which are fired for almost every significant action that users take on
* GitHub.
*
* @param {string} event - the name of the [GitHub webhook
* event](https://developer.github.com/webhooks/#events). Most events also
* include an "action". For example, the * [`issues`](
* https://developer.github.com/v3/activity/events/types/#issuesevent)
* event has actions of `assigned`, `unassigned`, `labeled`, `unlabeled`,
* `opened`, `edited`, `milestoned`, `demilestoned`, `closed`, and `reopened`.
* Often, your bot will only care about one type of action, so you can append
* it to the event name with a `.`, like `issues.closed`.
*
* @param {Application~webhookCallback} callback - a function to call when the
* webhook is received.
*
* @example
*
* app.on('push', context => {
* // Code was just pushed.
* });
*
* app.on('issues.opened', context => {
* // An issue was just opened.
* });
*/
Application.prototype.on = function (eventName, callback) {
var _this = this;
if (typeof eventName === 'string') {
return this.events.on(eventName, function (event) { return __awaiter(_this, void 0, void 0, function () {
var log, github, context, err_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
log = this.log.child({ name: 'event', id: event.id });
_a.label = 1;
case 1:
_a.trys.push([1, 7, , 8]);
github = void 0;
if (!isUnauthenticatedEvent(event)) return [3 /*break*/, 3];
return [4 /*yield*/, this.auth()];
case 2:
github = _a.sent();
log.debug('`context.github` is unauthenticated. See https://probot.github.io/docs/github-api/#unauthenticated-events');
return [3 /*break*/, 5];
case 3: return [4 /*yield*/, this.auth(event.payload.installation.id, log)];
case 4:
github = _a.sent();
_a.label = 5;
case 5:
context = new context_1.Context(event, github, log);
return [4 /*yield*/, callback(context)];
case 6:
_a.sent();
return [3 /*break*/, 8];
case 7:
err_1 = _a.sent();
log.error({ err: err_1, event: event });
if (!this.catchErrors) {
throw err_1;
}
return [3 /*break*/, 8];
case 8: return [2 /*return*/];
}
});
}); });
}
else {
eventName.forEach(function (e) { return _this.on(e, callback); });
}
};
/**
* Authenticate and get a GitHub client that can be used to make API calls.
*
* You'll probably want to use `context.github` instead.
*
* **Note**: `app.auth` is asynchronous, so it needs to be prefixed with a
* [`await`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/await)
* to wait for the magic to happen.
*
* @example
*
* module.exports = (app) => {
* app.on('issues.opened', async context => {
* const github = await app.auth();
* });
* };
*
* @param {number} [id] - ID of the installation, which can be extracted from
* `context.payload.installation.id`. If called without this parameter, the
* client wil authenticate [as the app](https://developer.github.com/apps/building-integrations/setting-up-and-registering-github-apps/about-authentication-options-for-github-apps/#authenticating-as-a-github-app)
* instead of as a specific installation, which means it can only be used for
* [app APIs](https://developer.github.com/v3/apps/).
*
* @returns {Promise&lt;github>} - An authenticated GitHub API client
* @private
*/
Application.prototype.auth = function (id, log) {
if (log === void 0) { log = this.log; }
return __awaiter(this, void 0, void 0, function () {
var _this = this;
var github, res;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
github = github_1.GitHubAPI({
baseUrl: process.env.GHE_HOST &amp;&amp; "https://" + process.env.GHE_HOST + "/api/v3",
debug: process.env.LOG_LEVEL === 'trace',
logger: log.child({ name: 'github', installation: String(id) })
});
if (!id) return [3 /*break*/, 2];
return [4 /*yield*/, this.cache.wrap("app:" + id + ":token", function () {
log.trace("creating token for installation");
github.authenticate({ type: 'app', token: _this.app() });
return github.apps.createInstallationToken({ installation_id: String(id) });
}, { ttl: 60 * 59 })]; // Cache for 1 minute less than GitHub expiry
case 1:
res = _a.sent() // Cache for 1 minute less than GitHub expiry
;
github.authenticate({ type: 'token', token: res.data.token });
return [3 /*break*/, 3];
case 2:
github.authenticate({ type: 'app', token: this.app() });
_a.label = 3;
case 3: return [2 /*return*/, github];
}
});
});
};
return Application;
}());
exports.Application = Application;
/**
* Do the thing
* @callback Application~webhookCallback
* @param {Context} context - the context of the event that was triggered,
* including `context.payload`, and helpers for extracting information from
* the payload, which can be passed to GitHub API calls.
*
* ```js
* module.exports = app => {
* app.on('push', context => {
* // Code was pushed to the repo, what should we do with it?
* app.log(context);
* });
* };
* ```
*/
/**
* A [GitHub webhook event](https://developer.github.com/webhooks/#events) payload
*
* @typedef payload
*/
//# sourceMappingURL=application.js.map</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jun 07 2018 21:35:41 GMT-0400 (EDT) using the Minami theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>

233
api/7.0.0-typescript.4/context.js.html Normal file
View File

@@ -0,0 +1,233 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>context.js - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#Application">Application</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#Context">Context</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#get">get</a></span></li>
</nav>
<div id="main">
<h1 class="page-title">context.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>"use strict";
var __awaiter = (this &amp;&amp; this.__awaiter) || function (thisArg, _arguments, P, generator) {
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this &amp;&amp; this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] &amp; 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" &amp;&amp; (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y &amp;&amp; (t = y[op[0] &amp; 2 ? "return" : op[0] ? "throw" : "next"]) &amp;&amp; !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [0, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 &amp;&amp; t[t.length - 1]) &amp;&amp; (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 &amp;&amp; (!t || (op[1] > t[0] &amp;&amp; op[1] &lt; t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 &amp;&amp; _.label &lt; t[1]) { _.label = t[1]; t = op; break; }
if (t &amp;&amp; _.label &lt; t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] &amp; 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
var yaml = require("js-yaml");
var path = require("path");
/**
* Helpers for extracting information from the webhook event, which can be
* passed to GitHub API calls.
*
* @property {github} github - A GitHub API client
* @property {payload} payload - The webhook event payload
* @property {logger} log - A logger
*/
var Context = /** @class */ (function () {
function Context(event, github, log) {
Object.assign(this, event);
this.id = event.id;
this.github = github;
this.log = log;
}
/**
* Return the `owner` and `repo` params for making API requests against a
* repository.
*
* @param {object} [object] - Params to be merged with the repo params.
*
* @example
*
* const params = context.repo({path: '.github/config.yml'})
* // Returns: {owner: 'username', repo: 'reponame', path: '.github/config.yml'}
*
*/
Context.prototype.repo = function (object) {
var repo = this.payload.repository;
if (!repo) {
throw new Error('context.repo() is not supported for this webhook event.');
}
return Object.assign({
owner: repo.owner.login || repo.owner.name,
repo: repo.name
}, object);
};
/**
* Return the `owner`, `repo`, and `number` params for making API requests
* against an issue or pull request. The object passed in will be merged with
* the repo params.
*
* @example
*
* const params = context.issue({body: 'Hello World!'})
* // Returns: {owner: 'username', repo: 'reponame', number: 123, body: 'Hello World!'}
*
* @param {object} [object] - Params to be merged with the issue params.
*/
Context.prototype.issue = function (object) {
var payload = this.payload;
return Object.assign({
number: (payload.issue || payload.pull_request || payload).number
}, this.repo(object));
};
Object.defineProperty(Context.prototype, "isBot", {
/**
* Returns a boolean if the actor on the event was a bot.
* @type {boolean}
*/
get: function () {
return this.payload.sender.type === 'Bot';
},
enumerable: true,
configurable: true
});
/**
* Reads the app configuration from the given YAML file in the `.github`
* directory of the repository.
*
* @example &lt;caption>Contents of &lt;code>.github/config.yml&lt;/code>.&lt;/caption>
*
* close: true
* comment: Check the specs on the rotary girder.
*
* @example &lt;caption>App that reads from &lt;code>.github/config.yml&lt;/code>.&lt;/caption>
*
* // Load config from .github/config.yml in the repository
* const config = await context.config('config.yml')
*
* if (config.close) {
* context.github.issues.comment(context.issue({body: config.comment}))
* context.github.issues.edit(context.issue({state: 'closed'}))
* }
*
* @example &lt;caption>Using a &lt;code>defaultConfig&lt;/code> object.&lt;/caption>
*
* // Load config from .github/config.yml in the repository and combine with default config
* const config = await context.config('config.yml', {comment: 'Make sure to check all the specs.'})
*
* if (config.close) {
* context.github.issues.comment(context.issue({body: config.comment}));
* context.github.issues.edit(context.issue({state: 'closed'}))
* }
*
* @param {string} fileName - Name of the YAML file in the `.github` directory
* @param {object} [defaultConfig] - An object of default config options
* @return {Promise&lt;Object>} - Configuration object read from the file
*/
Context.prototype.config = function (fileName, defaultConfig) {
return __awaiter(this, void 0, void 0, function () {
var params, res, config, err_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
params = this.repo({ path: path.posix.join('.github', fileName) });
_a.label = 1;
case 1:
_a.trys.push([1, 3, , 4]);
return [4 /*yield*/, this.github.repos.getContent(params)];
case 2:
res = _a.sent();
config = yaml.safeLoad(Buffer.from(res.data.content, 'base64').toString()) || {};
return [2 /*return*/, Object.assign({}, defaultConfig, config)];
case 3:
err_1 = _a.sent();
if (err_1.code === 404) {
if (defaultConfig) {
return [2 /*return*/, defaultConfig];
}
return [2 /*return*/, null];
}
else {
throw err_1;
}
return [3 /*break*/, 4];
case 4: return [2 /*return*/];
}
});
});
};
return Context;
}());
exports.Context = Context;
//# sourceMappingURL=context.js.map</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jun 07 2018 21:35:41 GMT-0400 (EDT) using the Minami theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>

663
api/7.0.0-typescript.4/global.html Normal file
View File

@@ -0,0 +1,663 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Global - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#Application">Application</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#Context">Context</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#get">get</a></span></li>
</nav>
<div id="main">
<h1 class="page-title">Global</h1>
<section>
<header>
<h2>
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<div class="section-members">
<h4 class="name" id="Application"><span class="type-signature"></span>Application<span class="type-signature"></span></h4>
<div class="description">
<p>The <code>app</code> parameter available to apps</p>
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>log</code></td>
<td class="type">
<span class="param-type"><code><a href="global.html#logger">logger</a></code></span>
</td>
<td class="description last"><p>A logger</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="application.js.html">application.js</a>, <a href="application.js.html#line54">line 54</a>
</li></ul></dd>
</dl>
</div>
<div class="section-members">
<h4 class="name" id="Context"><span class="type-signature"></span>Context<span class="type-signature"></span></h4>
<div class="description">
<p>Helpers for extracting information from the webhook event, which can be
passed to GitHub API calls.</p>
</div>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>github</code></td>
<td class="type">
<span class="param-type"><code>github</code></span>
</td>
<td class="description last"><p>A GitHub API client</p></td>
</tr>
<tr>
<td class="name"><code>payload</code></td>
<td class="type">
<span class="param-type"><code><a href="global.html#payload">payload</a></code></span>
</td>
<td class="description last"><p>The webhook event payload</p></td>
</tr>
<tr>
<td class="name"><code>log</code></td>
<td class="type">
<span class="param-type"><code><a href="global.html#logger">logger</a></code></span>
</td>
<td class="description last"><p>A logger</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="context.js.html">context.js</a>, <a href="context.js.html#line48">line 48</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<div class="section-method">
<h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Returns a boolean if the actor on the event was a bot.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="context.js.html">context.js</a>, <a href="context.js.html#line100">line 100</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Type Definitions</h3>
<div class="section-members">
<h4 class="name" id="logger">logger</h4>
<div class="description">
<p>A logger backed by <a href="https://github.com/trentm/node-bunyan">bunyan</a></p>
<p>The default log level is <code>info</code>, but you can change it by setting the
<code>LOG_LEVEL</code> environment variable to <code>trace</code>, <code>debug</code>, <code>info</code>, <code>warn</code>,
<code>error</code>, or <code>fatal</code>.</p>
<p>By default, logs are formatted for readability in development. If you intend
to drain logs to a logging service, set <code>LOG_FORMAT=json</code>.</p>
<p><strong>Note</strong>: All execptions reported with <code>logger.error</code> will be forwarded to
<a href="https://github.com/getsentry/sentry">sentry</a> if the <code>SENTRY_DSN</code> environment
variable is set.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="logger.js.html">logger.js</a>, <a href="logger.js.html#line2">line 2</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code>app.log("This is an info message");
app.log.debug("…so is this");
app.log.trace("Now we're talking");
app.log.info("I thought you should know…");
app.log.warn("Woah there");
app.log.error("ETOOMANYLOGS");
app.log.fatal("Goodbye, cruel world!");</code></pre>
</div>
<div class="section-members">
<h4 class="name" id="payload">payload</h4>
<div class="description">
<p>A <a href="https://developer.github.com/webhooks/#events">GitHub webhook event</a> payload</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="application.js.html">application.js</a>, <a href="application.js.html#line255">line 255</a>
</li></ul></dd>
</dl>
</div>
</article>
</section>
</div>
<br class="clear">
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jun 07 2018 21:35:41 GMT-0400 (EDT) using the Minami theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>

4
api/7.0.0-typescript.4/index.html
View File

@@ -24,7 +24,7 @@
<label for="nav-trigger" class="overlay"></label>
<nav>
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li>
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#Application">Application</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#Context">Context</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#get">get</a></span></li>
</nav>
<div id="main">
@@ -57,7 +57,7 @@
<br class="clear">
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jun 01 2018 15:04:28 GMT-0500 (CDT) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jun 07 2018 21:35:41 GMT-0400 (EDT) using the Minami theme.
</footer>
<script>prettyPrint();</script>

124
api/7.0.0-typescript.4/logger.js.html Normal file
View File

@@ -0,0 +1,124 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>logger.js - Documentation</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
<label for="nav-trigger" class="navicon-button x">
<div class="navicon"></div>
</label>
<label for="nav-trigger" class="overlay"></label>
<nav>
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#Application">Application</a></span></li><li class="nav-item"><span class="nav-item-type type-member">M</span><span class="nav-item-name"><a href="global.html#Context">Context</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#get">get</a></span></li>
</nav>
<div id="main">
<h1 class="page-title">logger.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>"use strict";
/**
* A logger backed by [bunyan](https://github.com/trentm/node-bunyan)
*
* The default log level is `info`, but you can change it by setting the
* `LOG_LEVEL` environment variable to `trace`, `debug`, `info`, `warn`,
* `error`, or `fatal`.
*
* By default, logs are formatted for readability in development. If you intend
* to drain logs to a logging service, set `LOG_FORMAT=json`.
*
* **Note**: All execptions reported with `logger.error` will be forwarded to
* [sentry](https://github.com/getsentry/sentry) if the `SENTRY_DSN` environment
* variable is set.
*
* @typedef logger
*
* @example
*
* app.log("This is an info message");
* app.log.debug("…so is this");
* app.log.trace("Now we're talking");
* app.log.info("I thought you should know…");
* app.log.warn("Woah there");
* app.log.error("ETOOMANYLOGS");
* app.log.fatal("Goodbye, cruel world!");
*/
Object.defineProperty(exports, "__esModule", { value: true });
var Logger = require("bunyan");
var bunyanFormat = require("bunyan-format");
var serializers_1 = require("./serializers");
function toBunyanLogLevel(level) {
switch (level) {
case 'info':
case 'trace':
case 'debug':
case 'warn':
case 'error':
case 'fatal':
case undefined:
return level;
default:
throw new Error('Invalid log level');
}
}
function toBunyanFormat(format) {
switch (format) {
case 'short':
case 'long':
case 'simple':
case 'json':
case 'bunyan':
case undefined:
return format;
default:
throw new Error('Invalid log format');
}
}
exports.logger = new Logger({
level: toBunyanLogLevel(process.env.LOG_LEVEL || 'info'),
name: 'probot',
serializers: serializers_1.serializers,
stream: new bunyanFormat({ outputMode: toBunyanFormat(process.env.LOG_FORMAT || 'short') }),
});
//# sourceMappingURL=logger.js.map</code></pre>
</article>
</section>
</div>
<br class="clear">
<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Jun 07 2018 21:35:41 GMT-0400 (EDT) using the Minami theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>