From 9515a3d4aa9d2b63014a19b17d3ed538d5261098 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Tue, 20 Aug 2024 19:14:29 +0000 Subject: [PATCH] Update docs from Probot v13.3.7 via probot/probot@880f2b93160e88bb9f5cdbd336c2b68702aa51f1 --- _submodules/probot | 2 +- api/13.3.7/assets/main.js | 2 +- api/13.3.7/assets/navigation.js | 2 +- api/13.3.7/classes/context.Context.html | 20 +++++++++---------- .../manifest_creation.ManifestCreation.html | 4 ++-- api/13.3.7/classes/probot.Probot.html | 4 ++-- api/13.3.7/classes/server_server.Server.html | 4 ++-- .../functions/apps_default.defaultApp.html | 2 +- .../functions/apps_setup.setupAppFactory.html | 2 +- api/13.3.7/functions/auth.auth.html | 2 +- .../bin_read_cli_options.readCliOptions.html | 2 +- .../bin_read_env_options.readEnvOptions.html | 2 +- ..._node_middleware.createNodeMiddleware.html | 2 +- .../functions/create_probot.createProbot.html | 2 +- .../functions/get_router.getRouter.html | 2 +- ...ers_get_error_handler.getErrorHandler.html | 2 +- .../functions/helpers_get_log.getLog.html | 2 +- .../helpers_is_production.isProduction.html | 2 +- ...d_node_version.isSupportedNodeVersion.html | 2 +- ...ers_load_package_json.loadPackageJson.html | 2 +- .../helpers_rebind_log.rebindLog.html | 2 +- ...solve_app_function.resolveAppFunction.html | 2 +- ...pers_webhook_proxy.createWebhookProxy.html | 2 +- ...cated_octokit.getAuthenticatedOctokit.html | 2 +- ...tle_options.getOctokitThrottleOptions.html | 2 +- ...defaults.getProbotOctokitWithDefaults.html | 2 +- .../octokit_get_webhooks.getWebhooks.html | 2 +- ..._request_logging.probotRequestLogging.html | 2 +- ...t_webhooks_transform.webhookTransform.html | 2 +- api/13.3.7/functions/run.run.html | 2 +- ...gging_middleware.getLoggingMiddleware.html | 2 +- .../functions/views_import.importView.html | 2 +- .../functions/views_probot.probotView.html | 2 +- .../functions/views_setup.setupView.html | 2 +- .../functions/views_success.successView.html | 2 +- ...s_resolve_app_function.ResolveOptions.html | 4 ++-- ...ers_webhook_proxy.WebhookProxyOptions.html | 4 ++-- api/13.3.7/interfaces/types.Options.html | 4 ++-- api/13.3.7/modules/apps_default.html | 2 +- api/13.3.7/modules/apps_setup.html | 2 +- api/13.3.7/modules/auth.html | 2 +- api/13.3.7/modules/bin_probot.html | 2 +- api/13.3.7/modules/bin_probot_receive.html | 2 +- api/13.3.7/modules/bin_probot_run.html | 2 +- api/13.3.7/modules/bin_read_cli_options.html | 2 +- api/13.3.7/modules/bin_read_env_options.html | 2 +- api/13.3.7/modules/context.html | 2 +- .../modules/create_node_middleware.html | 2 +- api/13.3.7/modules/create_probot.html | 2 +- api/13.3.7/modules/get_router.html | 2 +- .../modules/helpers_get_error_handler.html | 2 +- api/13.3.7/modules/helpers_get_log.html | 2 +- api/13.3.7/modules/helpers_is_production.html | 2 +- .../helpers_is_supported_node_version.html | 2 +- .../modules/helpers_load_package_json.html | 2 +- api/13.3.7/modules/helpers_rebind_log.html | 2 +- .../modules/helpers_resolve_app_function.html | 2 +- api/13.3.7/modules/helpers_webhook_proxy.html | 2 +- api/13.3.7/modules/index.html | 2 +- api/13.3.7/modules/manifest_creation.html | 2 +- .../octokit_get_authenticated_octokit.html | 2 +- .../octokit_get_octokit_throttle_options.html | 2 +- ...okit_get_probot_octokit_with_defaults.html | 2 +- api/13.3.7/modules/octokit_get_webhooks.html | 2 +- ...octokit_plugin_probot_request_logging.html | 2 +- .../octokit_octokit_webhooks_transform.html | 2 +- .../modules/octokit_probot_octokit.html | 2 +- api/13.3.7/modules/probot.html | 2 +- api/13.3.7/modules/run.html | 2 +- .../modules/server_logging_middleware.html | 2 +- api/13.3.7/modules/server_server.html | 2 +- api/13.3.7/modules/types.html | 2 +- api/13.3.7/modules/version.html | 2 +- api/13.3.7/modules/views_import.html | 2 +- api/13.3.7/modules/views_probot.html | 2 +- api/13.3.7/modules/views_setup.html | 2 +- api/13.3.7/modules/views_success.html | 2 +- api/13.3.7/types/context.MergeOptions.html | 2 +- .../types/helpers_get_log.GetLogOptions.html | 2 +- .../octokit_probot_octokit.ProbotOctokit.html | 2 +- api/13.3.7/types/probot.Constructor.html | 2 +- .../types/types.ApplicationFunction.html | 2 +- .../types.ApplicationFunctionOptions.html | 2 +- api/13.3.7/types/types.Env.html | 2 +- api/13.3.7/types/types.Manifest.html | 2 +- api/13.3.7/types/types.MiddlewareOptions.html | 2 +- api/13.3.7/types/types.OctokitOptions.html | 2 +- api/13.3.7/types/types.PackageJson.html | 2 +- api/13.3.7/types/types.ProbotWebhooks.html | 2 +- api/13.3.7/types/types.ServerOptions.html | 2 +- api/13.3.7/types/types.State.html | 2 +- ...ctokit_probot_octokit.ProbotOctokit-1.html | 2 +- .../server_server.defaultWebhooksPath.html | 2 +- api/13.3.7/variables/version.VERSION.html | 2 +- 94 files changed, 109 insertions(+), 109 deletions(-) diff --git a/_submodules/probot b/_submodules/probot index f06430bcbc9..880f2b93160 160000 --- a/_submodules/probot +++ b/_submodules/probot @@ -1 +1 @@ -Subproject commit f06430bcbc99410947b323154b02666eb653c417 +Subproject commit 880f2b93160e88bb9f5cdbd336c2b68702aa51f1 diff --git a/api/13.3.7/assets/main.js b/api/13.3.7/assets/main.js index 35728810f3c..21a5d74d22b 100644 --- a/api/13.3.7/assets/main.js +++ b/api/13.3.7/assets/main.js @@ -3,7 +3,7 @@ window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This me "use strict";(()=>{var Pe=Object.create;var ie=Object.defineProperty;var Oe=Object.getOwnPropertyDescriptor;var _e=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,Me=Object.prototype.hasOwnProperty;var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of _e(e))!Me.call(t,i)&&i!==n&&ie(t,i,{get:()=>e[i],enumerable:!(r=Oe(e,i))||r.enumerable});return t};var Ae=(t,e,n)=>(n=t!=null?Pe(Re(t)):{},De(e||!t||!t.__esModule?ie(n,"default",{value:t,enumerable:!0}):n,t));var ue=Fe((ae,le)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. `,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),m=s.str.charAt(1),p;m in s.node.edges?p=s.node.edges[m]:(p=new t.TokenSet,s.node.edges[m]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof ae=="object"?le.exports=n():e.lunr=n()}(this,function(){return t})})()});var se=[];function G(t,e){se.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){se.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!Ve(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function Ve(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var oe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var pe=Ae(ue());async function ce(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=pe.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function fe(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{ce(e,t)}),ce(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");i.addEventListener("mouseup",()=>{te(t)}),r.addEventListener("focus",()=>t.classList.add("has-focus")),He(t,i,r,e)}function He(t,e,n,r){n.addEventListener("input",oe(()=>{Ne(t,e,n,r)},200)),n.addEventListener("keydown",i=>{i.key=="Enter"?Be(e,t):i.key=="ArrowUp"?(de(e,n,-1),i.preventDefault()):i.key==="ArrowDown"&&(de(e,n,1),i.preventDefault())}),document.body.addEventListener("keypress",i=>{i.altKey||i.ctrlKey||i.metaKey||!n.matches(":focus")&&i.key==="/"&&(i.preventDefault(),n.focus())}),document.body.addEventListener("keyup",i=>{t.classList.contains("has-focus")&&(i.key==="Escape"||!e.matches(":focus-within")&&!n.matches(":focus"))&&(n.blur(),te(t))})}function te(t){t.classList.remove("has-focus")}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=he(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` ${he(l.parent,i)}.${d}`);let m=document.createElement("li");m.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,m.append(p),p.addEventListener("focus",()=>{e.querySelector(".current")?.classList.remove("current"),m.classList.add("current")}),e.appendChild(m)}}function de(t,e,n){let r=t.querySelector(".current");if(!r)r=t.querySelector(n==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let i=r;if(n===1)do i=i.nextElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);else do i=i.previousElementSibling??void 0;while(i instanceof HTMLElement&&i.offsetParent==null);i?(r.classList.remove("current"),i.classList.add("current")):n===-1&&(r.classList.remove("current"),e.focus())}}function Be(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),te(e)}}function he(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(ee(t.substring(s,o)),`${ee(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(ee(t.substring(s))),i.join("")}var je={"&":"&","<":"<",">":">","'":"'",'"':"""};function ee(t){return t.replace(/[&<>"'"]/g,e=>je[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",ye="mousemove",N="mouseup",J={x:0,y:0},me=!1,ne=!1,qe=!1,D=!1,ve=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(ve?"is-mobile":"not-mobile");ve&&"ontouchstart"in document.documentElement&&(qe=!0,F="touchstart",ye="touchmove",N="touchend");document.addEventListener(F,t=>{ne=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(ye,t=>{if(ne&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(N,()=>{ne=!1});document.addEventListener("click",t=>{me&&(t.preventDefault(),t.stopImmediatePropagation(),me=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(N,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(N,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var re;try{re=localStorage}catch{re={getItem(){return null},setItem(){}}}var Q=re;var ge=document.head.appendChild(document.createElement("style"));ge.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ge.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function Ee(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,xe(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),xe(t.value)})}function xe(t){document.documentElement.dataset.theme=t}var K;function we(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Le),Le())}async function Le(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();K=t.dataset.base,K.endsWith("/")||(K+="/"),t.innerHTML="";for(let s of i)Se(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Se(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',be(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)Se(u,l,i)}else be(t,r,t.class)}function be(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=K+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Te=document.getElementById("tsd-theme");Te&&Ee(Te);var $e=new U;Object.defineProperty(window,"app",{value:$e});fe();we();})(); +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function Ee(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,xe(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),xe(t.value)})}function xe(t){document.documentElement.dataset.theme=t}var K;function we(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Le),Le())}async function Le(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();K=t.dataset.base,K.endsWith("/")||(K+="/"),t.innerHTML="";for(let s of i)Se(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Se(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',be(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)Se(u,l,i)}else be(t,r,t.class)}function be(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=K+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Te=document.getElementById("tsd-theme");Te&&Ee(Te);var $e=new U;Object.defineProperty(window,"app",{value:$e});fe();we();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/api/13.3.7/assets/navigation.js b/api/13.3.7/assets/navigation.js index b8fc2d93770..0abd6398482 100644 --- a/api/13.3.7/assets/navigation.js +++ b/api/13.3.7/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA51Z227jNhD9Fz1HbTftbtu8BWl6Q7IJkkXysFgItMTIbGRSpSgnwWL/vaBIWrwML+6TDfOcM2dG4m38+Wsl8Kuozio0jlN1UrVbMnQc0+rs82Gow09oHkR1Uo1IbKuzase6ecDT95LT6NHvtmI3VCfVM6FddXaaVDofx1XsaaatIIx6civUVf7w07cv304OihMW8xhxtowV+VqQ5+P4O2oF429Rc0rRQwP+bIdoFlvA4Cy2RdZcuuVHCoQqXnk2hEYe6sjZhgHPdENoo8Y8e5aqGq85bjHZ45RGozF5rZmmdWYa1+AYdXU7kJqNS3FgJYlq2oE0GlVUfkm6GMiNL7w+CFDapSUf0WIe032BeUz3R5u/pPsS87a0S8u83i2jy7fAtR4oMnrhi7QDmiZL5AISe3f6i2XkGvMeB6mKt9GSsTGesR9+/fnd+1M3NY6RwDVlHa53pOsG/II48LorXCNxzYorSlxRP7IOXwMB1ucUCQHRky+bTik2+XUYcP6nErj19ALjWtFGJ332WNSczQLz0GSPRaPGihz2WNx5Sqs9S+uASxrb4mHEPLZTStuYc8brLaLdALnXAo2MvEAbDS1N5lKS/vTl15TiATxy9gEMrE/7H1hf5PoPLK5YH5mbvqADhiepY/PKdgmXQcoqZDJnMsmJ0c2LQjxzMjUrrCh/Mt0CuqFXV9lm5XxP8zgyLnCnVqs95lMuhwNFrSqaUpjPvSHLtefBjwZmFokHayXzHRjq6hG1z6jH9T9TKk8JbTS0kdCi/CTrVpH+ntKJhQE8cmbv3xDapSeawhTPNQXPTApL84DPGJ3YsMc1GsfayKUsL+gGjWNj0EXm7xQxWCkIFZg/oTYXw+V7Id9/CBOSp/ggHaheQLBQIlnCF7zZMvYsl5jXt3jtNKxZYEVFe1SMW0koqZwbAWCn6qZ2cJuUqpsbKuRmzpaEdvg1LNXyc/w2sEOUPOFJ1Es88EU1kMZAigp9rVkXga45roa6Pic8wdoJs1awZyISpwt548NUkBbJxX7FewnqgWX3cyiNHik9bZzb5Bs/3PrE8wEjYtlTiObXYsuZEAOO35NsD+a7YR11b+qx0O4+aXriClUUNaqYTV/fj00VXojY1ro3kimBvjmbnyTTdFeKy6CO6tr6IxHb34LQcCWSwVPC2YLoNSWTvEGVJvoYqMJ5HXQtTtKyeXDjMPeE1ofWyb+zXKIG1veEAru/iWk+FX3tqiz0RtOLklTUO8W88uOG2ZZFhlSL6mEKWQuO6PTE+C5fBMNpDpyizDXtUxgonjUQypdJpulO23hq7jwpSseZOv5tKqLrcHKXqkiAPeIEbRLmHV79zg3z46m3ucd6EEc0H/y2g9mGtQTUZ3B7RheMToLPso3rF1JrWIh8wwhsYoady8jBfQaPoJIeSARNcL5fmgHwZWaZlMkOlhIwk/rYJpa6WktmuokVjwIplGUMJ6I+iszfe0rmHXKV7gFB91XSm5vZE26R3bZfp44rC5Ays2Z5OcO8l5+L8k3dEJRKwS3gfBwHeYojjIbXJzV/lBYAzK0+ACXSOYqGKGweXdI9LHlJ9zmuOdfDAmY0q3J425MpBrCcrl6Dk6IuJrsnQO0QWy7a8ojtL+GJy5FzMDlFNT2T6TqQrJ5AAkd05FB+K4h24I7psz1c3t3/dfMRWkeMjIYAq4blheCXWMea7GTvDbApOY0aLesJLtAHgl+gpd+RW6EFR6iYtSOOCQqatqblVuj/+ddZSR35t3Pal/WPc97V3LZ4AnYHLaWGy5wpbMabFrTAYEPny38ofnf1ZiAAAA==" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA51a21LkNhD9F+cVJwvLbrK8UYTcChYKtuBha8ulsYVHwSM5tjxApfbfU7IkW5fWZfIENTrn9Om2deuZr/8WHL/y4qxAfT8WR0W9JV0zYFqcfV2GGvyEpo4XR0WP+LY4K3asmTo8/iQ4lRr9cct3XXFUPBPaFGcnUaXzvl/FniZac8KoI7dCbeWPp9+/fT9aFEfMpz7gbB7L8jUjz/v+N1RzNrwFzUlFBw34Mx2iiW8BgxPfZlmz6YYfIeCrOOXZEBp4qP3ANgx4phtCKznm2DNU5Xg54BqTPY5pVAqT1ppoXGeiYY0Bo6asO1Kyfi4OrCRQVd2RSqGyyi9IFx25cYXXBwFK27ToI5rNY7rPMI/p/mDzl3SfY96UtmmJ17tmdP7Pc60GsoxeuCJ1h8bRELmAxI5PfjGMXOOhxV6q/K03ZEyMY+zdp5+PP5zYqQ0YcVxS1uByR5qmwy9oAF53iasErlpxWYlL6mfW4GsgwPqcAiEgevRlUymFJr8KA87/WAK3jp5nXCma6KjPFvNyYBPHg2+yxbySY1kOW8zvHKXVnqG14KLGtrjr8RDaKYVtPAxsKLeINh3kXglUIvIMrRQ0N5lLQfrDlV9TCgdwyMkH0LE27r9jbZbr3zG/Ym1gbrqCFhiepJbNK9MlXAYhK5HRnMkoJkYzzQrhzMlYrbCs/Ml4C+j6Xm1lk5XyPU59zwaOG7la7fEwpnJYKHJVUZTMfO41Waw9D240MLNAPFgrmm/HUFP2qH5GLS7/HmN5CmiloJWAZuUnWLeS9NcYT8wP4JATe/+G0CY+0SQme65JeGJSGJoLPmF0ZN0el6jvSy0XszyjK9T3lUZnmb+TRG+lIJTj4QnVqRg23wn54aOfkDjFe+lA9QKC+RLREr7gzZaxZ7HEvL6Fa6dg1QzLKtqjZNwKQk7l7AgAO1Y3uYObpFjd7FA+N3G2JLTBr36p5o+zSnPe9x2pkTDlP2Zf7gcYL0OcHn86ff/u1LAHoL365wVZaaFY3gkZEF4xIZUce2kv7mkPEFkgcY2bmrNnkiO1IkOK93jYQwcuQ2qBhDTix3FAMUCI62fUzwGG9MBbsyEjx222OcF2iJInPPJyjgfODg2pNCRr4l0r1oWnq292vq7L8S97pnW2vBChg7hojmDKxVTDTclCr5oamA+KFqVSI7kH83OT7L3Z6+KYDhgQSx7YFb/k24Fx3uFwS8H0oP/XrINaDC3WU/OLoke6DVlRg4rJ9FUrSVfhhfBtqdqIiRKoJpP+SDB1IzK7DNY69Uj49lcvNFyJaPCYcLIgavtNJK9RuYk+eqpwXouuwYla1g+u76aW0HLpMv4ziSWqY21LKHBQ1jH1X0lfG5AzvVL0rCQl9U4yr9y4frZ5kSHVrHroQpZ8QHR8YsMuXQTNqRZOVuaK9sUPFM4aCOXKRNO0p204NXueZKUTOGXIxkNA1+Kk+g+BAHs0ELSJmLd45bEd5v2Jcw4OtesO6NO5Zw69DSsJqCVnt1cvGB35MIlvPNxCKg0Dke6tgicXv8kfuONO4G1N0D0J7/sidQSE7/3zpIw2e6WAntSH9ntlF0ow4/3ecBRIIS9jOBH5J8u8e8LW75CtdA8I2q+S2tz0nnCLzG+41qljywKkxKyZX04/7/njrHxjl2mpknFhjl5B5fyRWgAwtfrkXEATITL7rJd0D0te0n2Kq8/1sIAeTaosb3s0RQ+W0lVrcFTUxiT3BKhzaMoFu4Oh/cU/cVlyFialKKdnNF0LktTjiOOAjhhKbwXBZvUhLemHy7v7P28+Q+uIllEQYNUwvBD8Evpyh+xEmxqwKTiVHM1rn8/QB4JfoKXfkluhGUeokLUDjgkSGrem5Fbo//mBhpQ68BcacV/GjzPSrqa6xiOwOygpOZznTGIT3pSgAQZ7n9/+A/QSRreRIwAA" \ No newline at end of file diff --git a/api/13.3.7/classes/context.Context.html b/api/13.3.7/classes/context.Context.html index 76783643316..b60f2611e71 100644 --- a/api/13.3.7/classes/context.Context.html +++ b/api/13.3.7/classes/context.Context.html @@ -3,7 +3,7 @@ 
export default app => {
  app.on('push', context => {
    context.log.info('Code was pushed to the repo, what should we do with it?');
  });
};
-

Type Parameters

  • Event extends WebhookEvents = WebhookEvents

Constructors

constructor +

Type Parameters

  • Event extends WebhookEvents = WebhookEvents

Constructors

constructor

Properties

id log name @@ -14,11 +14,11 @@ issue pullRequest repo -

Constructors

constructor

  • new Context<Event>(event, octokit, log): Context<Event>

  • Type Parameters

    • Event extends
          | "status"
          | "branch_protection_configuration"
          | "branch_protection_rule.disabled"
          | "branch_protection_rule.enabled"
          | "branch_protection_rule"
          | "branch_protection_rule.created"
          | "branch_protection_rule.deleted"
          | "branch_protection_rule.edited"
          | "check_run"
          | "check_run.completed"
          | "check_run.created"
          | "check_run.requested_action"
          | "check_run.rerequested"
          | "check_suite"
          | "check_suite.completed"
          | "check_suite.requested"
          | "check_suite.rerequested"
          | "code_scanning_alert"
          | "code_scanning_alert.appeared_in_branch"
          | "code_scanning_alert.closed_by_user"
          | "code_scanning_alert.created"
          | "code_scanning_alert.fixed"
          | "code_scanning_alert.reopened"
          | "code_scanning_alert.reopened_by_user"
          | "commit_comment"
          | "commit_comment.created"
          | "create"
          | "custom_property"
          | "custom_property.created"
          | "custom_property.deleted"
          | "custom_property_values"
          | "custom_property_values.updated"
          | "delete"
          | "dependabot_alert"
          | "dependabot_alert.created"
          | "dependabot_alert.dismissed"
          | "dependabot_alert.fixed"
          | "dependabot_alert.reintroduced"
          | "dependabot_alert.reopened"
          | "deploy_key"
          | "deploy_key.created"
          | "deploy_key.deleted"
          | "deployment"
          | "deployment.created"
          | "deployment_protection_rule"
          | "deployment_protection_rule.requested"
          | "deployment_review"
          | "deployment_review.approved"
          | "deployment_review.rejected"
          | "deployment_review.requested"
          | "deployment_status"
          | "deployment_status.created"
          | "discussion"
          | "discussion.answered"
          | "discussion.category_changed"
          | "discussion.created"
          | "discussion.deleted"
          | "discussion.edited"
          | "discussion.labeled"
          | "discussion.locked"
          | "discussion.pinned"
          | "discussion.transferred"
          | "discussion.unanswered"
          | "discussion.unlabeled"
          | "discussion.unlocked"
          | "discussion.unpinned"
          | "discussion_comment"
          | "discussion_comment.created"
          | "discussion_comment.deleted"
          | "discussion_comment.edited"
          | "fork"
          | "github_app_authorization"
          | "github_app_authorization.revoked"
          | "gollum"
          | "installation"
          | "installation.created"
          | "installation.deleted"
          | "installation.new_permissions_accepted"
          | "installation.suspend"
          | "installation.unsuspend"
          | "installation_repositories"
          | "installation_repositories.added"
          | "installation_repositories.removed"
          | "installation_target"
          | "installation_target.renamed"
          | "issue_comment"
          | "issue_comment.created"
          | "issue_comment.deleted"
          | "issue_comment.edited"
          | "issues"
          | "issues.assigned"
          | "issues.closed"
          | "issues.deleted"
          | "issues.demilestoned"
          | "issues.edited"
          | "issues.labeled"
          | "issues.locked"
          | "issues.milestoned"
          | "issues.opened"
          | "issues.pinned"
          | "issues.reopened"
          | "issues.transferred"
          | "issues.unassigned"
          | "issues.unlabeled"
          | "issues.unlocked"
          | "issues.unpinned"
          | "label"
          | "label.created"
          | "label.deleted"
          | "label.edited"
          | "marketplace_purchase"
          | "marketplace_purchase.cancelled"
          | "marketplace_purchase.changed"
          | "marketplace_purchase.pending_change"
          | "marketplace_purchase.pending_change_cancelled"
          | "marketplace_purchase.purchased"
          | "member"
          | "member.added"
          | "member.edited"
          | "member.removed"
          | "membership"
          | "membership.added"
          | "membership.removed"
          | "merge_group"
          | "merge_group.checks_requested"
          | "meta"
          | "meta.deleted"
          | "milestone"
          | "milestone.closed"
          | "milestone.created"
          | "milestone.deleted"
          | "milestone.edited"
          | "milestone.opened"
          | "org_block"
          | "org_block.blocked"
          | "org_block.unblocked"
          | "organization"
          | "organization.deleted"
          | "organization.member_added"
          | "organization.member_invited"
          | "organization.member_removed"
          | "organization.renamed"
          | "package"
          | "package.published"
          | "package.updated"
          | "page_build"
          | "ping"
          | "project"
          | "project.closed"
          | "project.created"
          | "project.deleted"
          | "project.edited"
          | "project.reopened"
          | "project_card"
          | "project_card.converted"
          | "project_card.created"
          | "project_card.deleted"
          | "project_card.edited"
          | "project_card.moved"
          | "project_column"
          | "project_column.created"
          | "project_column.deleted"
          | "project_column.edited"
          | "project_column.moved"
          | "projects_v2_item"
          | "projects_v2_item.archived"
          | "projects_v2_item.converted"
          | "projects_v2_item.created"
          | "projects_v2_item.deleted"
          | "projects_v2_item.edited"
          | "projects_v2_item.reordered"
          | "projects_v2_item.restored"
          | "public"
          | "pull_request"
          | "pull_request.assigned"
          | "pull_request.auto_merge_disabled"
          | "pull_request.auto_merge_enabled"
          | "pull_request.closed"
          | "pull_request.converted_to_draft"
          | "pull_request.demilestoned"
          | "pull_request.dequeued"
          | "pull_request.edited"
          | "pull_request.enqueued"
          | "pull_request.labeled"
          | "pull_request.locked"
          | "pull_request.milestoned"
          | "pull_request.opened"
          | "pull_request.ready_for_review"
          | "pull_request.reopened"
          | "pull_request.review_request_removed"
          | "pull_request.review_requested"
          | "pull_request.synchronize"
          | "pull_request.unassigned"
          | "pull_request.unlabeled"
          | "pull_request.unlocked"
          | "pull_request_review"
          | "pull_request_review.dismissed"
          | "pull_request_review.edited"
          | "pull_request_review.submitted"
          | "pull_request_review_comment"
          | "pull_request_review_comment.created"
          | "pull_request_review_comment.deleted"
          | "pull_request_review_comment.edited"
          | "pull_request_review_thread"
          | "pull_request_review_thread.resolved"
          | "pull_request_review_thread.unresolved"
          | "push"
          | "registry_package"
          | "registry_package.published"
          | "registry_package.updated"
          | "release"
          | "release.created"
          | "release.deleted"
          | "release.edited"
          | "release.prereleased"
          | "release.published"
          | "release.released"
          | "release.unpublished"
          | "repository"
          | "repository.archived"
          | "repository.created"
          | "repository.deleted"
          | "repository.edited"
          | "repository.privatized"
          | "repository.publicized"
          | "repository.renamed"
          | "repository.transferred"
          | "repository.unarchived"
          | "repository_dispatch"
          | "repository_import"
          | "repository_vulnerability_alert"
          | "repository_vulnerability_alert.create"
          | "repository_vulnerability_alert.dismiss"
          | "repository_vulnerability_alert.reopen"
          | "repository_vulnerability_alert.resolve"
          | "secret_scanning_alert"
          | "secret_scanning_alert.created"
          | "secret_scanning_alert.reopened"
          | "secret_scanning_alert.resolved"
          | "secret_scanning_alert.revoked"
          | "secret_scanning_alert_location"
          | "secret_scanning_alert_location.created"
          | "security_advisory"
          | "security_advisory.performed"
          | "security_advisory.published"
          | "security_advisory.updated"
          | "security_advisory.withdrawn"
          | "sponsorship"
          | "sponsorship.cancelled"
          | "sponsorship.created"
          | "sponsorship.edited"
          | "sponsorship.pending_cancellation"
          | "sponsorship.pending_tier_change"
          | "sponsorship.tier_changed"
          | "star"
          | "star.created"
          | "star.deleted"
          | "team"
          | "team.added_to_repository"
          | "team.created"
          | "team.deleted"
          | "team.edited"
          | "team.removed_from_repository"
          | "team_add"
          | "watch"
          | "watch.started"
          | "workflow_dispatch"
          | "workflow_job"
          | "workflow_job.completed"
          | "workflow_job.in_progress"
          | "workflow_job.queued"
          | "workflow_job.waiting"
          | "workflow_run"
          | "workflow_run.completed"
          | "workflow_run.in_progress"
          | "workflow_run.requested" =
          | "status"
          | "branch_protection_configuration"
          | "branch_protection_rule.disabled"
          | "branch_protection_rule.enabled"
          | "branch_protection_rule"
          | "branch_protection_rule.created"
          | "branch_protection_rule.deleted"
          | "branch_protection_rule.edited"
          | "check_run"
          | "check_run.completed"
          | "check_run.created"
          | "check_run.requested_action"
          | "check_run.rerequested"
          | "check_suite"
          | "check_suite.completed"
          | "check_suite.requested"
          | "check_suite.rerequested"
          | "code_scanning_alert"
          | "code_scanning_alert.appeared_in_branch"
          | "code_scanning_alert.closed_by_user"
          | "code_scanning_alert.created"
          | "code_scanning_alert.fixed"
          | "code_scanning_alert.reopened"
          | "code_scanning_alert.reopened_by_user"
          | "commit_comment"
          | "commit_comment.created"
          | "create"
          | "custom_property"
          | "custom_property.created"
          | "custom_property.deleted"
          | "custom_property_values"
          | "custom_property_values.updated"
          | "delete"
          | "dependabot_alert"
          | "dependabot_alert.created"
          | "dependabot_alert.dismissed"
          | "dependabot_alert.fixed"
          | "dependabot_alert.reintroduced"
          | "dependabot_alert.reopened"
          | "deploy_key"
          | "deploy_key.created"
          | "deploy_key.deleted"
          | "deployment"
          | "deployment.created"
          | "deployment_protection_rule"
          | "deployment_protection_rule.requested"
          | "deployment_review"
          | "deployment_review.approved"
          | "deployment_review.rejected"
          | "deployment_review.requested"
          | "deployment_status"
          | "deployment_status.created"
          | "discussion"
          | "discussion.answered"
          | "discussion.category_changed"
          | "discussion.created"
          | "discussion.deleted"
          | "discussion.edited"
          | "discussion.labeled"
          | "discussion.locked"
          | "discussion.pinned"
          | "discussion.transferred"
          | "discussion.unanswered"
          | "discussion.unlabeled"
          | "discussion.unlocked"
          | "discussion.unpinned"
          | "discussion_comment"
          | "discussion_comment.created"
          | "discussion_comment.deleted"
          | "discussion_comment.edited"
          | "fork"
          | "github_app_authorization"
          | "github_app_authorization.revoked"
          | "gollum"
          | "installation"
          | "installation.created"
          | "installation.deleted"
          | "installation.new_permissions_accepted"
          | "installation.suspend"
          | "installation.unsuspend"
          | "installation_repositories"
          | "installation_repositories.added"
          | "installation_repositories.removed"
          | "installation_target"
          | "installation_target.renamed"
          | "issue_comment"
          | "issue_comment.created"
          | "issue_comment.deleted"
          | "issue_comment.edited"
          | "issues"
          | "issues.assigned"
          | "issues.closed"
          | "issues.deleted"
          | "issues.demilestoned"
          | "issues.edited"
          | "issues.labeled"
          | "issues.locked"
          | "issues.milestoned"
          | "issues.opened"
          | "issues.pinned"
          | "issues.reopened"
          | "issues.transferred"
          | "issues.unassigned"
          | "issues.unlabeled"
          | "issues.unlocked"
          | "issues.unpinned"
          | "label"
          | "label.created"
          | "label.deleted"
          | "label.edited"
          | "marketplace_purchase"
          | "marketplace_purchase.cancelled"
          | "marketplace_purchase.changed"
          | "marketplace_purchase.pending_change"
          | "marketplace_purchase.pending_change_cancelled"
          | "marketplace_purchase.purchased"
          | "member"
          | "member.added"
          | "member.edited"
          | "member.removed"
          | "membership"
          | "membership.added"
          | "membership.removed"
          | "merge_group"
          | "merge_group.checks_requested"
          | "meta"
          | "meta.deleted"
          | "milestone"
          | "milestone.closed"
          | "milestone.created"
          | "milestone.deleted"
          | "milestone.edited"
          | "milestone.opened"
          | "org_block"
          | "org_block.blocked"
          | "org_block.unblocked"
          | "organization"
          | "organization.deleted"
          | "organization.member_added"
          | "organization.member_invited"
          | "organization.member_removed"
          | "organization.renamed"
          | "package"
          | "package.published"
          | "package.updated"
          | "page_build"
          | "ping"
          | "project"
          | "project.closed"
          | "project.created"
          | "project.deleted"
          | "project.edited"
          | "project.reopened"
          | "project_card"
          | "project_card.converted"
          | "project_card.created"
          | "project_card.deleted"
          | "project_card.edited"
          | "project_card.moved"
          | "project_column"
          | "project_column.created"
          | "project_column.deleted"
          | "project_column.edited"
          | "project_column.moved"
          | "projects_v2_item"
          | "projects_v2_item.archived"
          | "projects_v2_item.converted"
          | "projects_v2_item.created"
          | "projects_v2_item.deleted"
          | "projects_v2_item.edited"
          | "projects_v2_item.reordered"
          | "projects_v2_item.restored"
          | "public"
          | "pull_request"
          | "pull_request.assigned"
          | "pull_request.auto_merge_disabled"
          | "pull_request.auto_merge_enabled"
          | "pull_request.closed"
          | "pull_request.converted_to_draft"
          | "pull_request.demilestoned"
          | "pull_request.dequeued"
          | "pull_request.edited"
          | "pull_request.enqueued"
          | "pull_request.labeled"
          | "pull_request.locked"
          | "pull_request.milestoned"
          | "pull_request.opened"
          | "pull_request.ready_for_review"
          | "pull_request.reopened"
          | "pull_request.review_request_removed"
          | "pull_request.review_requested"
          | "pull_request.synchronize"
          | "pull_request.unassigned"
          | "pull_request.unlabeled"
          | "pull_request.unlocked"
          | "pull_request_review"
          | "pull_request_review.dismissed"
          | "pull_request_review.edited"
          | "pull_request_review.submitted"
          | "pull_request_review_comment"
          | "pull_request_review_comment.created"
          | "pull_request_review_comment.deleted"
          | "pull_request_review_comment.edited"
          | "pull_request_review_thread"
          | "pull_request_review_thread.resolved"
          | "pull_request_review_thread.unresolved"
          | "push"
          | "registry_package"
          | "registry_package.published"
          | "registry_package.updated"
          | "release"
          | "release.created"
          | "release.deleted"
          | "release.edited"
          | "release.prereleased"
          | "release.published"
          | "release.released"
          | "release.unpublished"
          | "repository"
          | "repository.archived"
          | "repository.created"
          | "repository.deleted"
          | "repository.edited"
          | "repository.privatized"
          | "repository.publicized"
          | "repository.renamed"
          | "repository.transferred"
          | "repository.unarchived"
          | "repository_dispatch"
          | "repository_import"
          | "repository_vulnerability_alert"
          | "repository_vulnerability_alert.create"
          | "repository_vulnerability_alert.dismiss"
          | "repository_vulnerability_alert.reopen"
          | "repository_vulnerability_alert.resolve"
          | "secret_scanning_alert"
          | "secret_scanning_alert.created"
          | "secret_scanning_alert.reopened"
          | "secret_scanning_alert.resolved"
          | "secret_scanning_alert.revoked"
          | "secret_scanning_alert_location"
          | "secret_scanning_alert_location.created"
          | "security_advisory"
          | "security_advisory.performed"
          | "security_advisory.published"
          | "security_advisory.updated"
          | "security_advisory.withdrawn"
          | "sponsorship"
          | "sponsorship.cancelled"
          | "sponsorship.created"
          | "sponsorship.edited"
          | "sponsorship.pending_cancellation"
          | "sponsorship.pending_tier_change"
          | "sponsorship.tier_changed"
          | "star"
          | "star.created"
          | "star.deleted"
          | "team"
          | "team.added_to_repository"
          | "team.created"
          | "team.deleted"
          | "team.edited"
          | "team.removed_from_repository"
          | "team_add"
          | "watch"
          | "watch.started"
          | "workflow_dispatch"
          | "workflow_job"
          | "workflow_job.completed"
          | "workflow_job.in_progress"
          | "workflow_job.queued"
          | "workflow_job.waiting"
          | "workflow_run"
          | "workflow_run.completed"
          | "workflow_run.in_progress"
          | "workflow_run.requested"

    Parameters

    • event: EmitterWebhookEvent<Event>
    • octokit: Octokit & {} & {} & RestEndpointMethods & Api & API
    • log: Logger

    Returns Context<Event>

Properties

id

id: string

log

log: Logger

A pino instance

-

name

name:
    | "status"
    | "branch_protection_configuration"
    | "branch_protection_rule.disabled"
    | "branch_protection_rule.enabled"
    | "branch_protection_rule"
    | "branch_protection_rule.created"
    | "branch_protection_rule.deleted"
    | "branch_protection_rule.edited"
    | "check_run"
    | "check_run.completed"
    | "check_run.created"
    | "check_run.requested_action"
    | "check_run.rerequested"
    | "check_suite"
    | "check_suite.completed"
    | "check_suite.requested"
    | "check_suite.rerequested"
    | "code_scanning_alert"
    | "code_scanning_alert.appeared_in_branch"
    | "code_scanning_alert.closed_by_user"
    | "code_scanning_alert.created"
    | "code_scanning_alert.fixed"
    | "code_scanning_alert.reopened"
    | "code_scanning_alert.reopened_by_user"
    | "commit_comment"
    | "commit_comment.created"
    | "create"
    | "custom_property"
    | "custom_property.created"
    | "custom_property.deleted"
    | "custom_property_values"
    | "custom_property_values.updated"
    | "delete"
    | "dependabot_alert"
    | "dependabot_alert.created"
    | "dependabot_alert.dismissed"
    | "dependabot_alert.fixed"
    | "dependabot_alert.reintroduced"
    | "dependabot_alert.reopened"
    | "deploy_key"
    | "deploy_key.created"
    | "deploy_key.deleted"
    | "deployment"
    | "deployment.created"
    | "deployment_protection_rule"
    | "deployment_protection_rule.requested"
    | "deployment_review"
    | "deployment_review.approved"
    | "deployment_review.rejected"
    | "deployment_review.requested"
    | "deployment_status"
    | "deployment_status.created"
    | "discussion"
    | "discussion.answered"
    | "discussion.category_changed"
    | "discussion.created"
    | "discussion.deleted"
    | "discussion.edited"
    | "discussion.labeled"
    | "discussion.locked"
    | "discussion.pinned"
    | "discussion.transferred"
    | "discussion.unanswered"
    | "discussion.unlabeled"
    | "discussion.unlocked"
    | "discussion.unpinned"
    | "discussion_comment"
    | "discussion_comment.created"
    | "discussion_comment.deleted"
    | "discussion_comment.edited"
    | "fork"
    | "github_app_authorization"
    | "github_app_authorization.revoked"
    | "gollum"
    | "installation"
    | "installation.created"
    | "installation.deleted"
    | "installation.new_permissions_accepted"
    | "installation.suspend"
    | "installation.unsuspend"
    | "installation_repositories"
    | "installation_repositories.added"
    | "installation_repositories.removed"
    | "installation_target"
    | "installation_target.renamed"
    | "issue_comment"
    | "issue_comment.created"
    | "issue_comment.deleted"
    | "issue_comment.edited"
    | "issues"
    | "issues.assigned"
    | "issues.closed"
    | "issues.deleted"
    | "issues.demilestoned"
    | "issues.edited"
    | "issues.labeled"
    | "issues.locked"
    | "issues.milestoned"
    | "issues.opened"
    | "issues.pinned"
    | "issues.reopened"
    | "issues.transferred"
    | "issues.unassigned"
    | "issues.unlabeled"
    | "issues.unlocked"
    | "issues.unpinned"
    | "label"
    | "label.created"
    | "label.deleted"
    | "label.edited"
    | "marketplace_purchase"
    | "marketplace_purchase.cancelled"
    | "marketplace_purchase.changed"
    | "marketplace_purchase.pending_change"
    | "marketplace_purchase.pending_change_cancelled"
    | "marketplace_purchase.purchased"
    | "member"
    | "member.added"
    | "member.edited"
    | "member.removed"
    | "membership"
    | "membership.added"
    | "membership.removed"
    | "merge_group"
    | "merge_group.checks_requested"
    | "meta"
    | "meta.deleted"
    | "milestone"
    | "milestone.closed"
    | "milestone.created"
    | "milestone.deleted"
    | "milestone.edited"
    | "milestone.opened"
    | "org_block"
    | "org_block.blocked"
    | "org_block.unblocked"
    | "organization"
    | "organization.deleted"
    | "organization.member_added"
    | "organization.member_invited"
    | "organization.member_removed"
    | "organization.renamed"
    | "package"
    | "package.published"
    | "package.updated"
    | "page_build"
    | "ping"
    | "project"
    | "project.closed"
    | "project.created"
    | "project.deleted"
    | "project.edited"
    | "project.reopened"
    | "project_card"
    | "project_card.converted"
    | "project_card.created"
    | "project_card.deleted"
    | "project_card.edited"
    | "project_card.moved"
    | "project_column"
    | "project_column.created"
    | "project_column.deleted"
    | "project_column.edited"
    | "project_column.moved"
    | "projects_v2_item"
    | "projects_v2_item.archived"
    | "projects_v2_item.converted"
    | "projects_v2_item.created"
    | "projects_v2_item.deleted"
    | "projects_v2_item.edited"
    | "projects_v2_item.reordered"
    | "projects_v2_item.restored"
    | "public"
    | "pull_request"
    | "pull_request.assigned"
    | "pull_request.auto_merge_disabled"
    | "pull_request.auto_merge_enabled"
    | "pull_request.closed"
    | "pull_request.converted_to_draft"
    | "pull_request.demilestoned"
    | "pull_request.dequeued"
    | "pull_request.edited"
    | "pull_request.enqueued"
    | "pull_request.labeled"
    | "pull_request.locked"
    | "pull_request.milestoned"
    | "pull_request.opened"
    | "pull_request.ready_for_review"
    | "pull_request.reopened"
    | "pull_request.review_request_removed"
    | "pull_request.review_requested"
    | "pull_request.synchronize"
    | "pull_request.unassigned"
    | "pull_request.unlabeled"
    | "pull_request.unlocked"
    | "pull_request_review"
    | "pull_request_review.dismissed"
    | "pull_request_review.edited"
    | "pull_request_review.submitted"
    | "pull_request_review_comment"
    | "pull_request_review_comment.created"
    | "pull_request_review_comment.deleted"
    | "pull_request_review_comment.edited"
    | "pull_request_review_thread"
    | "pull_request_review_thread.resolved"
    | "pull_request_review_thread.unresolved"
    | "push"
    | "registry_package"
    | "registry_package.published"
    | "registry_package.updated"
    | "release"
    | "release.created"
    | "release.deleted"
    | "release.edited"
    | "release.prereleased"
    | "release.published"
    | "release.released"
    | "release.unpublished"
    | "repository"
    | "repository.archived"
    | "repository.created"
    | "repository.deleted"
    | "repository.edited"
    | "repository.privatized"
    | "repository.publicized"
    | "repository.renamed"
    | "repository.transferred"
    | "repository.unarchived"
    | "repository_dispatch"
    | "repository_import"
    | "repository_vulnerability_alert"
    | "repository_vulnerability_alert.create"
    | "repository_vulnerability_alert.dismiss"
    | "repository_vulnerability_alert.reopen"
    | "repository_vulnerability_alert.resolve"
    | "secret_scanning_alert"
    | "secret_scanning_alert.created"
    | "secret_scanning_alert.reopened"
    | "secret_scanning_alert.resolved"
    | "secret_scanning_alert.revoked"
    | "secret_scanning_alert_location"
    | "secret_scanning_alert_location.created"
    | "security_advisory"
    | "security_advisory.performed"
    | "security_advisory.published"
    | "security_advisory.updated"
    | "security_advisory.withdrawn"
    | "sponsorship"
    | "sponsorship.cancelled"
    | "sponsorship.created"
    | "sponsorship.edited"
    | "sponsorship.pending_cancellation"
    | "sponsorship.pending_tier_change"
    | "sponsorship.tier_changed"
    | "star"
    | "star.created"
    | "star.deleted"
    | "team"
    | "team.added_to_repository"
    | "team.created"
    | "team.deleted"
    | "team.edited"
    | "team.removed_from_repository"
    | "team_add"
    | "watch"
    | "watch.started"
    | "workflow_dispatch"
    | "workflow_job"
    | "workflow_job.completed"
    | "workflow_job.in_progress"
    | "workflow_job.queued"
    | "workflow_job.waiting"
    | "workflow_run"
    | "workflow_run.completed"
    | "workflow_run.in_progress"
    | "workflow_run.requested"

octokit

octokit: Octokit & {} & {} & RestEndpointMethods & Api & API

An Octokit instance

-

payload

payload: {
    [K in
        | "status"
        | "branch_protection_configuration"
        | "branch_protection_rule.disabled"
        | "branch_protection_rule.enabled"
        | "branch_protection_rule"
        | "branch_protection_rule.created"
        | "branch_protection_rule.deleted"
        | "branch_protection_rule.edited"
        | "check_run"
        | "check_run.completed"
        | "check_run.created"
        | "check_run.requested_action"
        | "check_run.rerequested"
        | "check_suite"
        | "check_suite.completed"
        | "check_suite.requested"
        | "check_suite.rerequested"
        | "code_scanning_alert"
        | "code_scanning_alert.appeared_in_branch"
        | "code_scanning_alert.closed_by_user"
        | "code_scanning_alert.created"
        | "code_scanning_alert.fixed"
        | "code_scanning_alert.reopened"
        | "code_scanning_alert.reopened_by_user"
        | "commit_comment"
        | "commit_comment.created"
        | "create"
        | "custom_property"
        | "custom_property.created"
        | "custom_property.deleted"
        | "custom_property_values"
        | "custom_property_values.updated"
        | "delete"
        | "dependabot_alert"
        | "dependabot_alert.created"
        | "dependabot_alert.dismissed"
        | "dependabot_alert.fixed"
        | "dependabot_alert.reintroduced"
        | "dependabot_alert.reopened"
        | "deploy_key"
        | "deploy_key.created"
        | "deploy_key.deleted"
        | "deployment"
        | "deployment.created"
        | "deployment_protection_rule"
        | "deployment_protection_rule.requested"
        | "deployment_review"
        | "deployment_review.approved"
        | "deployment_review.rejected"
        | "deployment_review.requested"
        | "deployment_status"
        | "deployment_status.created"
        | "discussion"
        | "discussion.answered"
        | "discussion.category_changed"
        | "discussion.created"
        | "discussion.deleted"
        | "discussion.edited"
        | "discussion.labeled"
        | "discussion.locked"
        | "discussion.pinned"
        | "discussion.transferred"
        | "discussion.unanswered"
        | "discussion.unlabeled"
        | "discussion.unlocked"
        | "discussion.unpinned"
        | "discussion_comment"
        | "discussion_comment.created"
        | "discussion_comment.deleted"
        | "discussion_comment.edited"
        | "fork"
        | "github_app_authorization"
        | "github_app_authorization.revoked"
        | "gollum"
        | "installation"
        | "installation.created"
        | "installation.deleted"
        | "installation.new_permissions_accepted"
        | "installation.suspend"
        | "installation.unsuspend"
        | "installation_repositories"
        | "installation_repositories.added"
        | "installation_repositories.removed"
        | "installation_target"
        | "installation_target.renamed"
        | "issue_comment"
        | "issue_comment.created"
        | "issue_comment.deleted"
        | "issue_comment.edited"
        | "issues"
        | "issues.assigned"
        | "issues.closed"
        | "issues.deleted"
        | "issues.demilestoned"
        | "issues.edited"
        | "issues.labeled"
        | "issues.locked"
        | "issues.milestoned"
        | "issues.opened"
        | "issues.pinned"
        | "issues.reopened"
        | "issues.transferred"
        | "issues.unassigned"
        | "issues.unlabeled"
        | "issues.unlocked"
        | "issues.unpinned"
        | "label"
        | "label.created"
        | "label.deleted"
        | "label.edited"
        | "marketplace_purchase"
        | "marketplace_purchase.cancelled"
        | "marketplace_purchase.changed"
        | "marketplace_purchase.pending_change"
        | "marketplace_purchase.pending_change_cancelled"
        | "marketplace_purchase.purchased"
        | "member"
        | "member.added"
        | "member.edited"
        | "member.removed"
        | "membership"
        | "membership.added"
        | "membership.removed"
        | "merge_group"
        | "merge_group.checks_requested"
        | "meta"
        | "meta.deleted"
        | "milestone"
        | "milestone.closed"
        | "milestone.created"
        | "milestone.deleted"
        | "milestone.edited"
        | "milestone.opened"
        | "org_block"
        | "org_block.blocked"
        | "org_block.unblocked"
        | "organization"
        | "organization.deleted"
        | "organization.member_added"
        | "organization.member_invited"
        | "organization.member_removed"
        | "organization.renamed"
        | "package"
        | "package.published"
        | "package.updated"
        | "page_build"
        | "ping"
        | "project"
        | "project.closed"
        | "project.created"
        | "project.deleted"
        | "project.edited"
        | "project.reopened"
        | "project_card"
        | "project_card.converted"
        | "project_card.created"
        | "project_card.deleted"
        | "project_card.edited"
        | "project_card.moved"
        | "project_column"
        | "project_column.created"
        | "project_column.deleted"
        | "project_column.edited"
        | "project_column.moved"
        | "projects_v2_item"
        | "projects_v2_item.archived"
        | "projects_v2_item.converted"
        | "projects_v2_item.created"
        | "projects_v2_item.deleted"
        | "projects_v2_item.edited"
        | "projects_v2_item.reordered"
        | "projects_v2_item.restored"
        | "public"
        | "pull_request"
        | "pull_request.assigned"
        | "pull_request.auto_merge_disabled"
        | "pull_request.auto_merge_enabled"
        | "pull_request.closed"
        | "pull_request.converted_to_draft"
        | "pull_request.demilestoned"
        | "pull_request.dequeued"
        | "pull_request.edited"
        | "pull_request.enqueued"
        | "pull_request.labeled"
        | "pull_request.locked"
        | "pull_request.milestoned"
        | "pull_request.opened"
        | "pull_request.ready_for_review"
        | "pull_request.reopened"
        | "pull_request.review_request_removed"
        | "pull_request.review_requested"
        | "pull_request.synchronize"
        | "pull_request.unassigned"
        | "pull_request.unlabeled"
        | "pull_request.unlocked"
        | "pull_request_review"
        | "pull_request_review.dismissed"
        | "pull_request_review.edited"
        | "pull_request_review.submitted"
        | "pull_request_review_comment"
        | "pull_request_review_comment.created"
        | "pull_request_review_comment.deleted"
        | "pull_request_review_comment.edited"
        | "pull_request_review_thread"
        | "pull_request_review_thread.resolved"
        | "pull_request_review_thread.unresolved"
        | "push"
        | "registry_package"
        | "registry_package.published"
        | "registry_package.updated"
        | "release"
        | "release.created"
        | "release.deleted"
        | "release.edited"
        | "release.prereleased"
        | "release.published"
        | "release.released"
        | "release.unpublished"
        | "repository"
        | "repository.archived"
        | "repository.created"
        | "repository.deleted"
        | "repository.edited"
        | "repository.privatized"
        | "repository.publicized"
        | "repository.renamed"
        | "repository.transferred"
        | "repository.unarchived"
        | "repository_dispatch"
        | "repository_import"
        | "repository_vulnerability_alert"
        | "repository_vulnerability_alert.create"
        | "repository_vulnerability_alert.dismiss"
        | "repository_vulnerability_alert.reopen"
        | "repository_vulnerability_alert.resolve"
        | "secret_scanning_alert"
        | "secret_scanning_alert.created"
        | "secret_scanning_alert.reopened"
        | "secret_scanning_alert.resolved"
        | "secret_scanning_alert.revoked"
        | "secret_scanning_alert_location"
        | "secret_scanning_alert_location.created"
        | "security_advisory"
        | "security_advisory.performed"
        | "security_advisory.published"
        | "security_advisory.updated"
        | "security_advisory.withdrawn"
        | "sponsorship"
        | "sponsorship.cancelled"
        | "sponsorship.created"
        | "sponsorship.edited"
        | "sponsorship.pending_cancellation"
        | "sponsorship.pending_tier_change"
        | "sponsorship.tier_changed"
        | "star"
        | "star.created"
        | "star.deleted"
        | "team"
        | "team.added_to_repository"
        | "team.created"
        | "team.deleted"
        | "team.edited"
        | "team.removed_from_repository"
        | "team_add"
        | "watch"
        | "watch.started"
        | "workflow_dispatch"
        | "workflow_job"
        | "workflow_job.completed"
        | "workflow_job.in_progress"
        | "workflow_job.queued"
        | "workflow_job.waiting"
        | "workflow_run"
        | "workflow_run.completed"
        | "workflow_run.in_progress"
        | "workflow_run.requested"]: K extends
            | "status"
            | "branch_protection_configuration"
            | "branch_protection_rule.disabled"
            | "branch_protection_rule.enabled"
            | "branch_protection_rule"
            | "branch_protection_rule.created"
            | "branch_protection_rule.deleted"
            | "branch_protection_rule.edited"
            | "check_run"
            | "check_run.completed"
            | "check_run.created"
            | "check_run.requested_action"
            | "check_run.rerequested"
            | "check_suite"
            | "check_suite.completed"
            | "check_suite.requested"
            | "check_suite.rerequested"
            | "code_scanning_alert"
            | "code_scanning_alert.appeared_in_branch"
            | "code_scanning_alert.closed_by_user"
            | "code_scanning_alert.created"
            | "code_scanning_alert.fixed"
            | "code_scanning_alert.reopened"
            | "code_scanning_alert.reopened_by_user"
            | "commit_comment"
            | "commit_comment.created"
            | "create"
            | "custom_property"
            | "custom_property.created"
            | "custom_property.deleted"
            | "custom_property_values"
            | "custom_property_values.updated"
            | "delete"
            | "dependabot_alert"
            | "dependabot_alert.created"
            | "dependabot_alert.dismissed"
            | "dependabot_alert.fixed"
            | "dependabot_alert.reintroduced"
            | "dependabot_alert.reopened"
            | "deploy_key"
            | "deploy_key.created"
            | "deploy_key.deleted"
            | "deployment"
            | "deployment.created"
            | "deployment_protection_rule"
            | "deployment_protection_rule.requested"
            | "deployment_review"
            | "deployment_review.approved"
            | "deployment_review.rejected"
            | "deployment_review.requested"
            | "deployment_status"
            | "deployment_status.created"
            | "discussion"
            | "discussion.answered"
            | "discussion.category_changed"
            | "discussion.created"
            | "discussion.deleted"
            | "discussion.edited"
            | "discussion.labeled"
            | "discussion.locked"
            | "discussion.pinned"
            | "discussion.transferred"
            | "discussion.unanswered"
            | "discussion.unlabeled"
            | "discussion.unlocked"
            | "discussion.unpinned"
            | "discussion_comment"
            | "discussion_comment.created"
            | "discussion_comment.deleted"
            | "discussion_comment.edited"
            | "fork"
            | "github_app_authorization"
            | "github_app_authorization.revoked"
            | "gollum"
            | "installation"
            | "installation.created"
            | "installation.deleted"
            | "installation.new_permissions_accepted"
            | "installation.suspend"
            | "installation.unsuspend"
            | "installation_repositories"
            | "installation_repositories.added"
            | "installation_repositories.removed"
            | "installation_target"
            | "installation_target.renamed"
            | "issue_comment"
            | "issue_comment.created"
            | "issue_comment.deleted"
            | "issue_comment.edited"
            | "issues"
            | "issues.assigned"
            | "issues.closed"
            | "issues.deleted"
            | "issues.demilestoned"
            | "issues.edited"
            | "issues.labeled"
            | "issues.locked"
            | "issues.milestoned"
            | "issues.opened"
            | "issues.pinned"
            | "issues.reopened"
            | "issues.transferred"
            | "issues.unassigned"
            | "issues.unlabeled"
            | "issues.unlocked"
            | "issues.unpinned"
            | "label"
            | "label.created"
            | "label.deleted"
            | "label.edited"
            | "marketplace_purchase"
            | "marketplace_purchase.cancelled"
            | "marketplace_purchase.changed"
            | "marketplace_purchase.pending_change"
            | "marketplace_purchase.pending_change_cancelled"
            | "marketplace_purchase.purchased"
            | "member"
            | "member.added"
            | "member.edited"
            | "member.removed"
            | "membership"
            | "membership.added"
            | "membership.removed"
            | "merge_group"
            | "merge_group.checks_requested"
            | "meta"
            | "meta.deleted"
            | "milestone"
            | "milestone.closed"
            | "milestone.created"
            | "milestone.deleted"
            | "milestone.edited"
            | "milestone.opened"
            | "org_block"
            | "org_block.blocked"
            | "org_block.unblocked"
            | "organization"
            | "organization.deleted"
            | "organization.member_added"
            | "organization.member_invited"
            | "organization.member_removed"
            | "organization.renamed"
            | "package"
            | "package.published"
            | "package.updated"
            | "page_build"
            | "ping"
            | "project"
            | "project.closed"
            | "project.created"
            | "project.deleted"
            | "project.edited"
            | "project.reopened"
            | "project_card"
            | "project_card.converted"
            | "project_card.created"
            | "project_card.deleted"
            | "project_card.edited"
            | "project_card.moved"
            | "project_column"
            | "project_column.created"
            | "project_column.deleted"
            | "project_column.edited"
            | "project_column.moved"
            | "projects_v2_item"
            | "projects_v2_item.archived"
            | "projects_v2_item.converted"
            | "projects_v2_item.created"
            | "projects_v2_item.deleted"
            | "projects_v2_item.edited"
            | "projects_v2_item.reordered"
            | "projects_v2_item.restored"
            | "public"
            | "pull_request"
            | "pull_request.assigned"
            | "pull_request.auto_merge_disabled"
            | "pull_request.auto_merge_enabled"
            | "pull_request.closed"
            | "pull_request.converted_to_draft"
            | "pull_request.demilestoned"
            | "pull_request.dequeued"
            | "pull_request.edited"
            | "pull_request.enqueued"
            | "pull_request.labeled"
            | "pull_request.locked"
            | "pull_request.milestoned"
            | "pull_request.opened"
            | "pull_request.ready_for_review"
            | "pull_request.reopened"
            | "pull_request.review_request_removed"
            | "pull_request.review_requested"
            | "pull_request.synchronize"
            | "pull_request.unassigned"
            | "pull_request.unlabeled"
            | "pull_request.unlocked"
            | "pull_request_review"
            | "pull_request_review.dismissed"
            | "pull_request_review.edited"
            | "pull_request_review.submitted"
            | "pull_request_review_comment"
            | "pull_request_review_comment.created"
            | "pull_request_review_comment.deleted"
            | "pull_request_review_comment.edited"
            | "pull_request_review_thread"
            | "pull_request_review_thread.resolved"
            | "pull_request_review_thread.unresolved"
            | "push"
            | "registry_package"
            | "registry_package.published"
            | "registry_package.updated"
            | "release"
            | "release.created"
            | "release.deleted"
            | "release.edited"
            | "release.prereleased"
            | "release.published"
            | "release.released"
            | "release.unpublished"
            | "repository"
            | "repository.archived"
            | "repository.created"
            | "repository.deleted"
            | "repository.edited"
            | "repository.privatized"
            | "repository.publicized"
            | "repository.renamed"
            | "repository.transferred"
            | "repository.unarchived"
            | "repository_dispatch"
            | "repository_import"
            | "repository_vulnerability_alert"
            | "repository_vulnerability_alert.create"
            | "repository_vulnerability_alert.dismiss"
            | "repository_vulnerability_alert.reopen"
            | "repository_vulnerability_alert.resolve"
            | "secret_scanning_alert"
            | "secret_scanning_alert.created"
            | "secret_scanning_alert.reopened"
            | "secret_scanning_alert.resolved"
            | "secret_scanning_alert.revoked"
            | "secret_scanning_alert_location"
            | "secret_scanning_alert_location.created"
            | "security_advisory"
            | "security_advisory.performed"
            | "security_advisory.published"
            | "security_advisory.updated"
            | "security_advisory.withdrawn"
            | "sponsorship"
            | "sponsorship.cancelled"
            | "sponsorship.created"
            | "sponsorship.edited"
            | "sponsorship.pending_cancellation"
            | "sponsorship.pending_tier_change"
            | "sponsorship.tier_changed"
            | "star"
            | "star.created"
            | "star.deleted"
            | "team"
            | "team.added_to_repository"
            | "team.created"
            | "team.deleted"
            | "team.edited"
            | "team.removed_from_repository"
            | "team_add"
            | "watch"
            | "watch.started"
            | "workflow_dispatch"
            | "workflow_job"
            | "workflow_job.completed"
            | "workflow_job.in_progress"
            | "workflow_job.queued"
            | "workflow_job.waiting"
            | "workflow_run"
            | "workflow_run.completed"
            | "workflow_run.in_progress"
            | "workflow_run.requested"
        ? EmitterWebhookEvent<K<K>>
        : never
}[Event]["payload"]

The webhook event payload

-

Accessors

isBot

  • get isBot(): boolean

  • Returns a boolean if the actor on the event was a bot.

    -

    Returns boolean

Methods

config

  • config<T>(fileName, defaultConfig?, deepMergeOptions?): Promise<null | T>

  • Reads the app configuration from the given YAML file in the .github +

Constructors

constructor

  • new Context<Event>(event, octokit, log): Context<Event>

  • Type Parameters

    • Event extends
          | "status"
          | "branch_protection_configuration"
          | "branch_protection_rule.disabled"
          | "branch_protection_rule.enabled"
          | "branch_protection_rule"
          | "branch_protection_rule.created"
          | "branch_protection_rule.deleted"
          | "branch_protection_rule.edited"
          | "check_run"
          | "check_run.completed"
          | "check_run.created"
          | "check_run.requested_action"
          | "check_run.rerequested"
          | "check_suite"
          | "check_suite.completed"
          | "check_suite.requested"
          | "check_suite.rerequested"
          | "code_scanning_alert"
          | "code_scanning_alert.appeared_in_branch"
          | "code_scanning_alert.closed_by_user"
          | "code_scanning_alert.created"
          | "code_scanning_alert.fixed"
          | "code_scanning_alert.reopened"
          | "code_scanning_alert.reopened_by_user"
          | "commit_comment"
          | "commit_comment.created"
          | "create"
          | "custom_property"
          | "custom_property.created"
          | "custom_property.deleted"
          | "custom_property_values"
          | "custom_property_values.updated"
          | "delete"
          | "dependabot_alert"
          | "dependabot_alert.created"
          | "dependabot_alert.dismissed"
          | "dependabot_alert.fixed"
          | "dependabot_alert.reintroduced"
          | "dependabot_alert.reopened"
          | "deploy_key"
          | "deploy_key.created"
          | "deploy_key.deleted"
          | "deployment"
          | "deployment.created"
          | "deployment_protection_rule"
          | "deployment_protection_rule.requested"
          | "deployment_review"
          | "deployment_review.approved"
          | "deployment_review.rejected"
          | "deployment_review.requested"
          | "deployment_status"
          | "deployment_status.created"
          | "discussion"
          | "discussion.answered"
          | "discussion.category_changed"
          | "discussion.created"
          | "discussion.deleted"
          | "discussion.edited"
          | "discussion.labeled"
          | "discussion.locked"
          | "discussion.pinned"
          | "discussion.transferred"
          | "discussion.unanswered"
          | "discussion.unlabeled"
          | "discussion.unlocked"
          | "discussion.unpinned"
          | "discussion_comment"
          | "discussion_comment.created"
          | "discussion_comment.deleted"
          | "discussion_comment.edited"
          | "fork"
          | "github_app_authorization"
          | "github_app_authorization.revoked"
          | "gollum"
          | "installation"
          | "installation.created"
          | "installation.deleted"
          | "installation.new_permissions_accepted"
          | "installation.suspend"
          | "installation.unsuspend"
          | "installation_repositories"
          | "installation_repositories.added"
          | "installation_repositories.removed"
          | "installation_target"
          | "installation_target.renamed"
          | "issue_comment"
          | "issue_comment.created"
          | "issue_comment.deleted"
          | "issue_comment.edited"
          | "issues"
          | "issues.assigned"
          | "issues.closed"
          | "issues.deleted"
          | "issues.demilestoned"
          | "issues.edited"
          | "issues.labeled"
          | "issues.locked"
          | "issues.milestoned"
          | "issues.opened"
          | "issues.pinned"
          | "issues.reopened"
          | "issues.transferred"
          | "issues.unassigned"
          | "issues.unlabeled"
          | "issues.unlocked"
          | "issues.unpinned"
          | "label"
          | "label.created"
          | "label.deleted"
          | "label.edited"
          | "marketplace_purchase"
          | "marketplace_purchase.cancelled"
          | "marketplace_purchase.changed"
          | "marketplace_purchase.pending_change"
          | "marketplace_purchase.pending_change_cancelled"
          | "marketplace_purchase.purchased"
          | "member"
          | "member.added"
          | "member.edited"
          | "member.removed"
          | "membership"
          | "membership.added"
          | "membership.removed"
          | "merge_group"
          | "merge_group.checks_requested"
          | "meta"
          | "meta.deleted"
          | "milestone"
          | "milestone.closed"
          | "milestone.created"
          | "milestone.deleted"
          | "milestone.edited"
          | "milestone.opened"
          | "org_block"
          | "org_block.blocked"
          | "org_block.unblocked"
          | "organization"
          | "organization.deleted"
          | "organization.member_added"
          | "organization.member_invited"
          | "organization.member_removed"
          | "organization.renamed"
          | "package"
          | "package.published"
          | "package.updated"
          | "page_build"
          | "ping"
          | "project"
          | "project.closed"
          | "project.created"
          | "project.deleted"
          | "project.edited"
          | "project.reopened"
          | "project_card"
          | "project_card.converted"
          | "project_card.created"
          | "project_card.deleted"
          | "project_card.edited"
          | "project_card.moved"
          | "project_column"
          | "project_column.created"
          | "project_column.deleted"
          | "project_column.edited"
          | "project_column.moved"
          | "projects_v2_item"
          | "projects_v2_item.archived"
          | "projects_v2_item.converted"
          | "projects_v2_item.created"
          | "projects_v2_item.deleted"
          | "projects_v2_item.edited"
          | "projects_v2_item.reordered"
          | "projects_v2_item.restored"
          | "public"
          | "pull_request"
          | "pull_request.assigned"
          | "pull_request.auto_merge_disabled"
          | "pull_request.auto_merge_enabled"
          | "pull_request.closed"
          | "pull_request.converted_to_draft"
          | "pull_request.demilestoned"
          | "pull_request.dequeued"
          | "pull_request.edited"
          | "pull_request.enqueued"
          | "pull_request.labeled"
          | "pull_request.locked"
          | "pull_request.milestoned"
          | "pull_request.opened"
          | "pull_request.ready_for_review"
          | "pull_request.reopened"
          | "pull_request.review_request_removed"
          | "pull_request.review_requested"
          | "pull_request.synchronize"
          | "pull_request.unassigned"
          | "pull_request.unlabeled"
          | "pull_request.unlocked"
          | "pull_request_review"
          | "pull_request_review.dismissed"
          | "pull_request_review.edited"
          | "pull_request_review.submitted"
          | "pull_request_review_comment"
          | "pull_request_review_comment.created"
          | "pull_request_review_comment.deleted"
          | "pull_request_review_comment.edited"
          | "pull_request_review_thread"
          | "pull_request_review_thread.resolved"
          | "pull_request_review_thread.unresolved"
          | "push"
          | "registry_package"
          | "registry_package.published"
          | "registry_package.updated"
          | "release"
          | "release.created"
          | "release.deleted"
          | "release.edited"
          | "release.prereleased"
          | "release.published"
          | "release.released"
          | "release.unpublished"
          | "repository"
          | "repository.archived"
          | "repository.created"
          | "repository.deleted"
          | "repository.edited"
          | "repository.privatized"
          | "repository.publicized"
          | "repository.renamed"
          | "repository.transferred"
          | "repository.unarchived"
          | "repository_dispatch"
          | "repository_import"
          | "repository_vulnerability_alert"
          | "repository_vulnerability_alert.create"
          | "repository_vulnerability_alert.dismiss"
          | "repository_vulnerability_alert.reopen"
          | "repository_vulnerability_alert.resolve"
          | "secret_scanning_alert"
          | "secret_scanning_alert.created"
          | "secret_scanning_alert.reopened"
          | "secret_scanning_alert.resolved"
          | "secret_scanning_alert.revoked"
          | "secret_scanning_alert_location"
          | "secret_scanning_alert_location.created"
          | "security_advisory"
          | "security_advisory.performed"
          | "security_advisory.published"
          | "security_advisory.updated"
          | "security_advisory.withdrawn"
          | "sponsorship"
          | "sponsorship.cancelled"
          | "sponsorship.created"
          | "sponsorship.edited"
          | "sponsorship.pending_cancellation"
          | "sponsorship.pending_tier_change"
          | "sponsorship.tier_changed"
          | "star"
          | "star.created"
          | "star.deleted"
          | "team"
          | "team.added_to_repository"
          | "team.created"
          | "team.deleted"
          | "team.edited"
          | "team.removed_from_repository"
          | "team_add"
          | "watch"
          | "watch.started"
          | "workflow_dispatch"
          | "workflow_job"
          | "workflow_job.completed"
          | "workflow_job.in_progress"
          | "workflow_job.queued"
          | "workflow_job.waiting"
          | "workflow_run"
          | "workflow_run.completed"
          | "workflow_run.in_progress"
          | "workflow_run.requested" =
          | "status"
          | "branch_protection_configuration"
          | "branch_protection_rule.disabled"
          | "branch_protection_rule.enabled"
          | "branch_protection_rule"
          | "branch_protection_rule.created"
          | "branch_protection_rule.deleted"
          | "branch_protection_rule.edited"
          | "check_run"
          | "check_run.completed"
          | "check_run.created"
          | "check_run.requested_action"
          | "check_run.rerequested"
          | "check_suite"
          | "check_suite.completed"
          | "check_suite.requested"
          | "check_suite.rerequested"
          | "code_scanning_alert"
          | "code_scanning_alert.appeared_in_branch"
          | "code_scanning_alert.closed_by_user"
          | "code_scanning_alert.created"
          | "code_scanning_alert.fixed"
          | "code_scanning_alert.reopened"
          | "code_scanning_alert.reopened_by_user"
          | "commit_comment"
          | "commit_comment.created"
          | "create"
          | "custom_property"
          | "custom_property.created"
          | "custom_property.deleted"
          | "custom_property_values"
          | "custom_property_values.updated"
          | "delete"
          | "dependabot_alert"
          | "dependabot_alert.created"
          | "dependabot_alert.dismissed"
          | "dependabot_alert.fixed"
          | "dependabot_alert.reintroduced"
          | "dependabot_alert.reopened"
          | "deploy_key"
          | "deploy_key.created"
          | "deploy_key.deleted"
          | "deployment"
          | "deployment.created"
          | "deployment_protection_rule"
          | "deployment_protection_rule.requested"
          | "deployment_review"
          | "deployment_review.approved"
          | "deployment_review.rejected"
          | "deployment_review.requested"
          | "deployment_status"
          | "deployment_status.created"
          | "discussion"
          | "discussion.answered"
          | "discussion.category_changed"
          | "discussion.created"
          | "discussion.deleted"
          | "discussion.edited"
          | "discussion.labeled"
          | "discussion.locked"
          | "discussion.pinned"
          | "discussion.transferred"
          | "discussion.unanswered"
          | "discussion.unlabeled"
          | "discussion.unlocked"
          | "discussion.unpinned"
          | "discussion_comment"
          | "discussion_comment.created"
          | "discussion_comment.deleted"
          | "discussion_comment.edited"
          | "fork"
          | "github_app_authorization"
          | "github_app_authorization.revoked"
          | "gollum"
          | "installation"
          | "installation.created"
          | "installation.deleted"
          | "installation.new_permissions_accepted"
          | "installation.suspend"
          | "installation.unsuspend"
          | "installation_repositories"
          | "installation_repositories.added"
          | "installation_repositories.removed"
          | "installation_target"
          | "installation_target.renamed"
          | "issue_comment"
          | "issue_comment.created"
          | "issue_comment.deleted"
          | "issue_comment.edited"
          | "issues"
          | "issues.assigned"
          | "issues.closed"
          | "issues.deleted"
          | "issues.demilestoned"
          | "issues.edited"
          | "issues.labeled"
          | "issues.locked"
          | "issues.milestoned"
          | "issues.opened"
          | "issues.pinned"
          | "issues.reopened"
          | "issues.transferred"
          | "issues.unassigned"
          | "issues.unlabeled"
          | "issues.unlocked"
          | "issues.unpinned"
          | "label"
          | "label.created"
          | "label.deleted"
          | "label.edited"
          | "marketplace_purchase"
          | "marketplace_purchase.cancelled"
          | "marketplace_purchase.changed"
          | "marketplace_purchase.pending_change"
          | "marketplace_purchase.pending_change_cancelled"
          | "marketplace_purchase.purchased"
          | "member"
          | "member.added"
          | "member.edited"
          | "member.removed"
          | "membership"
          | "membership.added"
          | "membership.removed"
          | "merge_group"
          | "merge_group.checks_requested"
          | "meta"
          | "meta.deleted"
          | "milestone"
          | "milestone.closed"
          | "milestone.created"
          | "milestone.deleted"
          | "milestone.edited"
          | "milestone.opened"
          | "org_block"
          | "org_block.blocked"
          | "org_block.unblocked"
          | "organization"
          | "organization.deleted"
          | "organization.member_added"
          | "organization.member_invited"
          | "organization.member_removed"
          | "organization.renamed"
          | "package"
          | "package.published"
          | "package.updated"
          | "page_build"
          | "ping"
          | "project"
          | "project.closed"
          | "project.created"
          | "project.deleted"
          | "project.edited"
          | "project.reopened"
          | "project_card"
          | "project_card.converted"
          | "project_card.created"
          | "project_card.deleted"
          | "project_card.edited"
          | "project_card.moved"
          | "project_column"
          | "project_column.created"
          | "project_column.deleted"
          | "project_column.edited"
          | "project_column.moved"
          | "projects_v2_item"
          | "projects_v2_item.archived"
          | "projects_v2_item.converted"
          | "projects_v2_item.created"
          | "projects_v2_item.deleted"
          | "projects_v2_item.edited"
          | "projects_v2_item.reordered"
          | "projects_v2_item.restored"
          | "public"
          | "pull_request"
          | "pull_request.assigned"
          | "pull_request.auto_merge_disabled"
          | "pull_request.auto_merge_enabled"
          | "pull_request.closed"
          | "pull_request.converted_to_draft"
          | "pull_request.demilestoned"
          | "pull_request.dequeued"
          | "pull_request.edited"
          | "pull_request.enqueued"
          | "pull_request.labeled"
          | "pull_request.locked"
          | "pull_request.milestoned"
          | "pull_request.opened"
          | "pull_request.ready_for_review"
          | "pull_request.reopened"
          | "pull_request.review_request_removed"
          | "pull_request.review_requested"
          | "pull_request.synchronize"
          | "pull_request.unassigned"
          | "pull_request.unlabeled"
          | "pull_request.unlocked"
          | "pull_request_review"
          | "pull_request_review.dismissed"
          | "pull_request_review.edited"
          | "pull_request_review.submitted"
          | "pull_request_review_comment"
          | "pull_request_review_comment.created"
          | "pull_request_review_comment.deleted"
          | "pull_request_review_comment.edited"
          | "pull_request_review_thread"
          | "pull_request_review_thread.resolved"
          | "pull_request_review_thread.unresolved"
          | "push"
          | "registry_package"
          | "registry_package.published"
          | "registry_package.updated"
          | "release"
          | "release.created"
          | "release.deleted"
          | "release.edited"
          | "release.prereleased"
          | "release.published"
          | "release.released"
          | "release.unpublished"
          | "repository"
          | "repository.archived"
          | "repository.created"
          | "repository.deleted"
          | "repository.edited"
          | "repository.privatized"
          | "repository.publicized"
          | "repository.renamed"
          | "repository.transferred"
          | "repository.unarchived"
          | "repository_dispatch"
          | "repository_import"
          | "repository_vulnerability_alert"
          | "repository_vulnerability_alert.create"
          | "repository_vulnerability_alert.dismiss"
          | "repository_vulnerability_alert.reopen"
          | "repository_vulnerability_alert.resolve"
          | "secret_scanning_alert"
          | "secret_scanning_alert.created"
          | "secret_scanning_alert.reopened"
          | "secret_scanning_alert.resolved"
          | "secret_scanning_alert.revoked"
          | "secret_scanning_alert_location"
          | "secret_scanning_alert_location.created"
          | "security_advisory"
          | "security_advisory.performed"
          | "security_advisory.published"
          | "security_advisory.updated"
          | "security_advisory.withdrawn"
          | "sponsorship"
          | "sponsorship.cancelled"
          | "sponsorship.created"
          | "sponsorship.edited"
          | "sponsorship.pending_cancellation"
          | "sponsorship.pending_tier_change"
          | "sponsorship.tier_changed"
          | "star"
          | "star.created"
          | "star.deleted"
          | "team"
          | "team.added_to_repository"
          | "team.created"
          | "team.deleted"
          | "team.edited"
          | "team.removed_from_repository"
          | "team_add"
          | "watch"
          | "watch.started"
          | "workflow_dispatch"
          | "workflow_job"
          | "workflow_job.completed"
          | "workflow_job.in_progress"
          | "workflow_job.queued"
          | "workflow_job.waiting"
          | "workflow_run"
          | "workflow_run.completed"
          | "workflow_run.in_progress"
          | "workflow_run.requested"

    Parameters

    • event: EmitterWebhookEvent<Event>
    • octokit: Octokit & {} & {} & RestEndpointMethods & Api & API
    • log: Logger

    Returns Context<Event>

Properties

id

id: string

log

log: Logger

A pino instance

+

name

name:
    | "status"
    | "branch_protection_configuration"
    | "branch_protection_rule.disabled"
    | "branch_protection_rule.enabled"
    | "branch_protection_rule"
    | "branch_protection_rule.created"
    | "branch_protection_rule.deleted"
    | "branch_protection_rule.edited"
    | "check_run"
    | "check_run.completed"
    | "check_run.created"
    | "check_run.requested_action"
    | "check_run.rerequested"
    | "check_suite"
    | "check_suite.completed"
    | "check_suite.requested"
    | "check_suite.rerequested"
    | "code_scanning_alert"
    | "code_scanning_alert.appeared_in_branch"
    | "code_scanning_alert.closed_by_user"
    | "code_scanning_alert.created"
    | "code_scanning_alert.fixed"
    | "code_scanning_alert.reopened"
    | "code_scanning_alert.reopened_by_user"
    | "commit_comment"
    | "commit_comment.created"
    | "create"
    | "custom_property"
    | "custom_property.created"
    | "custom_property.deleted"
    | "custom_property_values"
    | "custom_property_values.updated"
    | "delete"
    | "dependabot_alert"
    | "dependabot_alert.created"
    | "dependabot_alert.dismissed"
    | "dependabot_alert.fixed"
    | "dependabot_alert.reintroduced"
    | "dependabot_alert.reopened"
    | "deploy_key"
    | "deploy_key.created"
    | "deploy_key.deleted"
    | "deployment"
    | "deployment.created"
    | "deployment_protection_rule"
    | "deployment_protection_rule.requested"
    | "deployment_review"
    | "deployment_review.approved"
    | "deployment_review.rejected"
    | "deployment_review.requested"
    | "deployment_status"
    | "deployment_status.created"
    | "discussion"
    | "discussion.answered"
    | "discussion.category_changed"
    | "discussion.created"
    | "discussion.deleted"
    | "discussion.edited"
    | "discussion.labeled"
    | "discussion.locked"
    | "discussion.pinned"
    | "discussion.transferred"
    | "discussion.unanswered"
    | "discussion.unlabeled"
    | "discussion.unlocked"
    | "discussion.unpinned"
    | "discussion_comment"
    | "discussion_comment.created"
    | "discussion_comment.deleted"
    | "discussion_comment.edited"
    | "fork"
    | "github_app_authorization"
    | "github_app_authorization.revoked"
    | "gollum"
    | "installation"
    | "installation.created"
    | "installation.deleted"
    | "installation.new_permissions_accepted"
    | "installation.suspend"
    | "installation.unsuspend"
    | "installation_repositories"
    | "installation_repositories.added"
    | "installation_repositories.removed"
    | "installation_target"
    | "installation_target.renamed"
    | "issue_comment"
    | "issue_comment.created"
    | "issue_comment.deleted"
    | "issue_comment.edited"
    | "issues"
    | "issues.assigned"
    | "issues.closed"
    | "issues.deleted"
    | "issues.demilestoned"
    | "issues.edited"
    | "issues.labeled"
    | "issues.locked"
    | "issues.milestoned"
    | "issues.opened"
    | "issues.pinned"
    | "issues.reopened"
    | "issues.transferred"
    | "issues.unassigned"
    | "issues.unlabeled"
    | "issues.unlocked"
    | "issues.unpinned"
    | "label"
    | "label.created"
    | "label.deleted"
    | "label.edited"
    | "marketplace_purchase"
    | "marketplace_purchase.cancelled"
    | "marketplace_purchase.changed"
    | "marketplace_purchase.pending_change"
    | "marketplace_purchase.pending_change_cancelled"
    | "marketplace_purchase.purchased"
    | "member"
    | "member.added"
    | "member.edited"
    | "member.removed"
    | "membership"
    | "membership.added"
    | "membership.removed"
    | "merge_group"
    | "merge_group.checks_requested"
    | "meta"
    | "meta.deleted"
    | "milestone"
    | "milestone.closed"
    | "milestone.created"
    | "milestone.deleted"
    | "milestone.edited"
    | "milestone.opened"
    | "org_block"
    | "org_block.blocked"
    | "org_block.unblocked"
    | "organization"
    | "organization.deleted"
    | "organization.member_added"
    | "organization.member_invited"
    | "organization.member_removed"
    | "organization.renamed"
    | "package"
    | "package.published"
    | "package.updated"
    | "page_build"
    | "ping"
    | "project"
    | "project.closed"
    | "project.created"
    | "project.deleted"
    | "project.edited"
    | "project.reopened"
    | "project_card"
    | "project_card.converted"
    | "project_card.created"
    | "project_card.deleted"
    | "project_card.edited"
    | "project_card.moved"
    | "project_column"
    | "project_column.created"
    | "project_column.deleted"
    | "project_column.edited"
    | "project_column.moved"
    | "projects_v2_item"
    | "projects_v2_item.archived"
    | "projects_v2_item.converted"
    | "projects_v2_item.created"
    | "projects_v2_item.deleted"
    | "projects_v2_item.edited"
    | "projects_v2_item.reordered"
    | "projects_v2_item.restored"
    | "public"
    | "pull_request"
    | "pull_request.assigned"
    | "pull_request.auto_merge_disabled"
    | "pull_request.auto_merge_enabled"
    | "pull_request.closed"
    | "pull_request.converted_to_draft"
    | "pull_request.demilestoned"
    | "pull_request.dequeued"
    | "pull_request.edited"
    | "pull_request.enqueued"
    | "pull_request.labeled"
    | "pull_request.locked"
    | "pull_request.milestoned"
    | "pull_request.opened"
    | "pull_request.ready_for_review"
    | "pull_request.reopened"
    | "pull_request.review_request_removed"
    | "pull_request.review_requested"
    | "pull_request.synchronize"
    | "pull_request.unassigned"
    | "pull_request.unlabeled"
    | "pull_request.unlocked"
    | "pull_request_review"
    | "pull_request_review.dismissed"
    | "pull_request_review.edited"
    | "pull_request_review.submitted"
    | "pull_request_review_comment"
    | "pull_request_review_comment.created"
    | "pull_request_review_comment.deleted"
    | "pull_request_review_comment.edited"
    | "pull_request_review_thread"
    | "pull_request_review_thread.resolved"
    | "pull_request_review_thread.unresolved"
    | "push"
    | "registry_package"
    | "registry_package.published"
    | "registry_package.updated"
    | "release"
    | "release.created"
    | "release.deleted"
    | "release.edited"
    | "release.prereleased"
    | "release.published"
    | "release.released"
    | "release.unpublished"
    | "repository"
    | "repository.archived"
    | "repository.created"
    | "repository.deleted"
    | "repository.edited"
    | "repository.privatized"
    | "repository.publicized"
    | "repository.renamed"
    | "repository.transferred"
    | "repository.unarchived"
    | "repository_dispatch"
    | "repository_import"
    | "repository_vulnerability_alert"
    | "repository_vulnerability_alert.create"
    | "repository_vulnerability_alert.dismiss"
    | "repository_vulnerability_alert.reopen"
    | "repository_vulnerability_alert.resolve"
    | "secret_scanning_alert"
    | "secret_scanning_alert.created"
    | "secret_scanning_alert.reopened"
    | "secret_scanning_alert.resolved"
    | "secret_scanning_alert.revoked"
    | "secret_scanning_alert_location"
    | "secret_scanning_alert_location.created"
    | "security_advisory"
    | "security_advisory.performed"
    | "security_advisory.published"
    | "security_advisory.updated"
    | "security_advisory.withdrawn"
    | "sponsorship"
    | "sponsorship.cancelled"
    | "sponsorship.created"
    | "sponsorship.edited"
    | "sponsorship.pending_cancellation"
    | "sponsorship.pending_tier_change"
    | "sponsorship.tier_changed"
    | "star"
    | "star.created"
    | "star.deleted"
    | "team"
    | "team.added_to_repository"
    | "team.created"
    | "team.deleted"
    | "team.edited"
    | "team.removed_from_repository"
    | "team_add"
    | "watch"
    | "watch.started"
    | "workflow_dispatch"
    | "workflow_job"
    | "workflow_job.completed"
    | "workflow_job.in_progress"
    | "workflow_job.queued"
    | "workflow_job.waiting"
    | "workflow_run"
    | "workflow_run.completed"
    | "workflow_run.in_progress"
    | "workflow_run.requested"

octokit

octokit: Octokit & {} & {} & RestEndpointMethods & Api & API

An Octokit instance

+

payload

payload: {
    [K in
        | "status"
        | "branch_protection_configuration"
        | "branch_protection_rule.disabled"
        | "branch_protection_rule.enabled"
        | "branch_protection_rule"
        | "branch_protection_rule.created"
        | "branch_protection_rule.deleted"
        | "branch_protection_rule.edited"
        | "check_run"
        | "check_run.completed"
        | "check_run.created"
        | "check_run.requested_action"
        | "check_run.rerequested"
        | "check_suite"
        | "check_suite.completed"
        | "check_suite.requested"
        | "check_suite.rerequested"
        | "code_scanning_alert"
        | "code_scanning_alert.appeared_in_branch"
        | "code_scanning_alert.closed_by_user"
        | "code_scanning_alert.created"
        | "code_scanning_alert.fixed"
        | "code_scanning_alert.reopened"
        | "code_scanning_alert.reopened_by_user"
        | "commit_comment"
        | "commit_comment.created"
        | "create"
        | "custom_property"
        | "custom_property.created"
        | "custom_property.deleted"
        | "custom_property_values"
        | "custom_property_values.updated"
        | "delete"
        | "dependabot_alert"
        | "dependabot_alert.created"
        | "dependabot_alert.dismissed"
        | "dependabot_alert.fixed"
        | "dependabot_alert.reintroduced"
        | "dependabot_alert.reopened"
        | "deploy_key"
        | "deploy_key.created"
        | "deploy_key.deleted"
        | "deployment"
        | "deployment.created"
        | "deployment_protection_rule"
        | "deployment_protection_rule.requested"
        | "deployment_review"
        | "deployment_review.approved"
        | "deployment_review.rejected"
        | "deployment_review.requested"
        | "deployment_status"
        | "deployment_status.created"
        | "discussion"
        | "discussion.answered"
        | "discussion.category_changed"
        | "discussion.created"
        | "discussion.deleted"
        | "discussion.edited"
        | "discussion.labeled"
        | "discussion.locked"
        | "discussion.pinned"
        | "discussion.transferred"
        | "discussion.unanswered"
        | "discussion.unlabeled"
        | "discussion.unlocked"
        | "discussion.unpinned"
        | "discussion_comment"
        | "discussion_comment.created"
        | "discussion_comment.deleted"
        | "discussion_comment.edited"
        | "fork"
        | "github_app_authorization"
        | "github_app_authorization.revoked"
        | "gollum"
        | "installation"
        | "installation.created"
        | "installation.deleted"
        | "installation.new_permissions_accepted"
        | "installation.suspend"
        | "installation.unsuspend"
        | "installation_repositories"
        | "installation_repositories.added"
        | "installation_repositories.removed"
        | "installation_target"
        | "installation_target.renamed"
        | "issue_comment"
        | "issue_comment.created"
        | "issue_comment.deleted"
        | "issue_comment.edited"
        | "issues"
        | "issues.assigned"
        | "issues.closed"
        | "issues.deleted"
        | "issues.demilestoned"
        | "issues.edited"
        | "issues.labeled"
        | "issues.locked"
        | "issues.milestoned"
        | "issues.opened"
        | "issues.pinned"
        | "issues.reopened"
        | "issues.transferred"
        | "issues.unassigned"
        | "issues.unlabeled"
        | "issues.unlocked"
        | "issues.unpinned"
        | "label"
        | "label.created"
        | "label.deleted"
        | "label.edited"
        | "marketplace_purchase"
        | "marketplace_purchase.cancelled"
        | "marketplace_purchase.changed"
        | "marketplace_purchase.pending_change"
        | "marketplace_purchase.pending_change_cancelled"
        | "marketplace_purchase.purchased"
        | "member"
        | "member.added"
        | "member.edited"
        | "member.removed"
        | "membership"
        | "membership.added"
        | "membership.removed"
        | "merge_group"
        | "merge_group.checks_requested"
        | "meta"
        | "meta.deleted"
        | "milestone"
        | "milestone.closed"
        | "milestone.created"
        | "milestone.deleted"
        | "milestone.edited"
        | "milestone.opened"
        | "org_block"
        | "org_block.blocked"
        | "org_block.unblocked"
        | "organization"
        | "organization.deleted"
        | "organization.member_added"
        | "organization.member_invited"
        | "organization.member_removed"
        | "organization.renamed"
        | "package"
        | "package.published"
        | "package.updated"
        | "page_build"
        | "ping"
        | "project"
        | "project.closed"
        | "project.created"
        | "project.deleted"
        | "project.edited"
        | "project.reopened"
        | "project_card"
        | "project_card.converted"
        | "project_card.created"
        | "project_card.deleted"
        | "project_card.edited"
        | "project_card.moved"
        | "project_column"
        | "project_column.created"
        | "project_column.deleted"
        | "project_column.edited"
        | "project_column.moved"
        | "projects_v2_item"
        | "projects_v2_item.archived"
        | "projects_v2_item.converted"
        | "projects_v2_item.created"
        | "projects_v2_item.deleted"
        | "projects_v2_item.edited"
        | "projects_v2_item.reordered"
        | "projects_v2_item.restored"
        | "public"
        | "pull_request"
        | "pull_request.assigned"
        | "pull_request.auto_merge_disabled"
        | "pull_request.auto_merge_enabled"
        | "pull_request.closed"
        | "pull_request.converted_to_draft"
        | "pull_request.demilestoned"
        | "pull_request.dequeued"
        | "pull_request.edited"
        | "pull_request.enqueued"
        | "pull_request.labeled"
        | "pull_request.locked"
        | "pull_request.milestoned"
        | "pull_request.opened"
        | "pull_request.ready_for_review"
        | "pull_request.reopened"
        | "pull_request.review_request_removed"
        | "pull_request.review_requested"
        | "pull_request.synchronize"
        | "pull_request.unassigned"
        | "pull_request.unlabeled"
        | "pull_request.unlocked"
        | "pull_request_review"
        | "pull_request_review.dismissed"
        | "pull_request_review.edited"
        | "pull_request_review.submitted"
        | "pull_request_review_comment"
        | "pull_request_review_comment.created"
        | "pull_request_review_comment.deleted"
        | "pull_request_review_comment.edited"
        | "pull_request_review_thread"
        | "pull_request_review_thread.resolved"
        | "pull_request_review_thread.unresolved"
        | "push"
        | "registry_package"
        | "registry_package.published"
        | "registry_package.updated"
        | "release"
        | "release.created"
        | "release.deleted"
        | "release.edited"
        | "release.prereleased"
        | "release.published"
        | "release.released"
        | "release.unpublished"
        | "repository"
        | "repository.archived"
        | "repository.created"
        | "repository.deleted"
        | "repository.edited"
        | "repository.privatized"
        | "repository.publicized"
        | "repository.renamed"
        | "repository.transferred"
        | "repository.unarchived"
        | "repository_dispatch"
        | "repository_import"
        | "repository_vulnerability_alert"
        | "repository_vulnerability_alert.create"
        | "repository_vulnerability_alert.dismiss"
        | "repository_vulnerability_alert.reopen"
        | "repository_vulnerability_alert.resolve"
        | "secret_scanning_alert"
        | "secret_scanning_alert.created"
        | "secret_scanning_alert.reopened"
        | "secret_scanning_alert.resolved"
        | "secret_scanning_alert.revoked"
        | "secret_scanning_alert_location"
        | "secret_scanning_alert_location.created"
        | "security_advisory"
        | "security_advisory.performed"
        | "security_advisory.published"
        | "security_advisory.updated"
        | "security_advisory.withdrawn"
        | "sponsorship"
        | "sponsorship.cancelled"
        | "sponsorship.created"
        | "sponsorship.edited"
        | "sponsorship.pending_cancellation"
        | "sponsorship.pending_tier_change"
        | "sponsorship.tier_changed"
        | "star"
        | "star.created"
        | "star.deleted"
        | "team"
        | "team.added_to_repository"
        | "team.created"
        | "team.deleted"
        | "team.edited"
        | "team.removed_from_repository"
        | "team_add"
        | "watch"
        | "watch.started"
        | "workflow_dispatch"
        | "workflow_job"
        | "workflow_job.completed"
        | "workflow_job.in_progress"
        | "workflow_job.queued"
        | "workflow_job.waiting"
        | "workflow_run"
        | "workflow_run.completed"
        | "workflow_run.in_progress"
        | "workflow_run.requested"]: K extends
            | "status"
            | "branch_protection_configuration"
            | "branch_protection_rule.disabled"
            | "branch_protection_rule.enabled"
            | "branch_protection_rule"
            | "branch_protection_rule.created"
            | "branch_protection_rule.deleted"
            | "branch_protection_rule.edited"
            | "check_run"
            | "check_run.completed"
            | "check_run.created"
            | "check_run.requested_action"
            | "check_run.rerequested"
            | "check_suite"
            | "check_suite.completed"
            | "check_suite.requested"
            | "check_suite.rerequested"
            | "code_scanning_alert"
            | "code_scanning_alert.appeared_in_branch"
            | "code_scanning_alert.closed_by_user"
            | "code_scanning_alert.created"
            | "code_scanning_alert.fixed"
            | "code_scanning_alert.reopened"
            | "code_scanning_alert.reopened_by_user"
            | "commit_comment"
            | "commit_comment.created"
            | "create"
            | "custom_property"
            | "custom_property.created"
            | "custom_property.deleted"
            | "custom_property_values"
            | "custom_property_values.updated"
            | "delete"
            | "dependabot_alert"
            | "dependabot_alert.created"
            | "dependabot_alert.dismissed"
            | "dependabot_alert.fixed"
            | "dependabot_alert.reintroduced"
            | "dependabot_alert.reopened"
            | "deploy_key"
            | "deploy_key.created"
            | "deploy_key.deleted"
            | "deployment"
            | "deployment.created"
            | "deployment_protection_rule"
            | "deployment_protection_rule.requested"
            | "deployment_review"
            | "deployment_review.approved"
            | "deployment_review.rejected"
            | "deployment_review.requested"
            | "deployment_status"
            | "deployment_status.created"
            | "discussion"
            | "discussion.answered"
            | "discussion.category_changed"
            | "discussion.created"
            | "discussion.deleted"
            | "discussion.edited"
            | "discussion.labeled"
            | "discussion.locked"
            | "discussion.pinned"
            | "discussion.transferred"
            | "discussion.unanswered"
            | "discussion.unlabeled"
            | "discussion.unlocked"
            | "discussion.unpinned"
            | "discussion_comment"
            | "discussion_comment.created"
            | "discussion_comment.deleted"
            | "discussion_comment.edited"
            | "fork"
            | "github_app_authorization"
            | "github_app_authorization.revoked"
            | "gollum"
            | "installation"
            | "installation.created"
            | "installation.deleted"
            | "installation.new_permissions_accepted"
            | "installation.suspend"
            | "installation.unsuspend"
            | "installation_repositories"
            | "installation_repositories.added"
            | "installation_repositories.removed"
            | "installation_target"
            | "installation_target.renamed"
            | "issue_comment"
            | "issue_comment.created"
            | "issue_comment.deleted"
            | "issue_comment.edited"
            | "issues"
            | "issues.assigned"
            | "issues.closed"
            | "issues.deleted"
            | "issues.demilestoned"
            | "issues.edited"
            | "issues.labeled"
            | "issues.locked"
            | "issues.milestoned"
            | "issues.opened"
            | "issues.pinned"
            | "issues.reopened"
            | "issues.transferred"
            | "issues.unassigned"
            | "issues.unlabeled"
            | "issues.unlocked"
            | "issues.unpinned"
            | "label"
            | "label.created"
            | "label.deleted"
            | "label.edited"
            | "marketplace_purchase"
            | "marketplace_purchase.cancelled"
            | "marketplace_purchase.changed"
            | "marketplace_purchase.pending_change"
            | "marketplace_purchase.pending_change_cancelled"
            | "marketplace_purchase.purchased"
            | "member"
            | "member.added"
            | "member.edited"
            | "member.removed"
            | "membership"
            | "membership.added"
            | "membership.removed"
            | "merge_group"
            | "merge_group.checks_requested"
            | "meta"
            | "meta.deleted"
            | "milestone"
            | "milestone.closed"
            | "milestone.created"
            | "milestone.deleted"
            | "milestone.edited"
            | "milestone.opened"
            | "org_block"
            | "org_block.blocked"
            | "org_block.unblocked"
            | "organization"
            | "organization.deleted"
            | "organization.member_added"
            | "organization.member_invited"
            | "organization.member_removed"
            | "organization.renamed"
            | "package"
            | "package.published"
            | "package.updated"
            | "page_build"
            | "ping"
            | "project"
            | "project.closed"
            | "project.created"
            | "project.deleted"
            | "project.edited"
            | "project.reopened"
            | "project_card"
            | "project_card.converted"
            | "project_card.created"
            | "project_card.deleted"
            | "project_card.edited"
            | "project_card.moved"
            | "project_column"
            | "project_column.created"
            | "project_column.deleted"
            | "project_column.edited"
            | "project_column.moved"
            | "projects_v2_item"
            | "projects_v2_item.archived"
            | "projects_v2_item.converted"
            | "projects_v2_item.created"
            | "projects_v2_item.deleted"
            | "projects_v2_item.edited"
            | "projects_v2_item.reordered"
            | "projects_v2_item.restored"
            | "public"
            | "pull_request"
            | "pull_request.assigned"
            | "pull_request.auto_merge_disabled"
            | "pull_request.auto_merge_enabled"
            | "pull_request.closed"
            | "pull_request.converted_to_draft"
            | "pull_request.demilestoned"
            | "pull_request.dequeued"
            | "pull_request.edited"
            | "pull_request.enqueued"
            | "pull_request.labeled"
            | "pull_request.locked"
            | "pull_request.milestoned"
            | "pull_request.opened"
            | "pull_request.ready_for_review"
            | "pull_request.reopened"
            | "pull_request.review_request_removed"
            | "pull_request.review_requested"
            | "pull_request.synchronize"
            | "pull_request.unassigned"
            | "pull_request.unlabeled"
            | "pull_request.unlocked"
            | "pull_request_review"
            | "pull_request_review.dismissed"
            | "pull_request_review.edited"
            | "pull_request_review.submitted"
            | "pull_request_review_comment"
            | "pull_request_review_comment.created"
            | "pull_request_review_comment.deleted"
            | "pull_request_review_comment.edited"
            | "pull_request_review_thread"
            | "pull_request_review_thread.resolved"
            | "pull_request_review_thread.unresolved"
            | "push"
            | "registry_package"
            | "registry_package.published"
            | "registry_package.updated"
            | "release"
            | "release.created"
            | "release.deleted"
            | "release.edited"
            | "release.prereleased"
            | "release.published"
            | "release.released"
            | "release.unpublished"
            | "repository"
            | "repository.archived"
            | "repository.created"
            | "repository.deleted"
            | "repository.edited"
            | "repository.privatized"
            | "repository.publicized"
            | "repository.renamed"
            | "repository.transferred"
            | "repository.unarchived"
            | "repository_dispatch"
            | "repository_import"
            | "repository_vulnerability_alert"
            | "repository_vulnerability_alert.create"
            | "repository_vulnerability_alert.dismiss"
            | "repository_vulnerability_alert.reopen"
            | "repository_vulnerability_alert.resolve"
            | "secret_scanning_alert"
            | "secret_scanning_alert.created"
            | "secret_scanning_alert.reopened"
            | "secret_scanning_alert.resolved"
            | "secret_scanning_alert.revoked"
            | "secret_scanning_alert_location"
            | "secret_scanning_alert_location.created"
            | "security_advisory"
            | "security_advisory.performed"
            | "security_advisory.published"
            | "security_advisory.updated"
            | "security_advisory.withdrawn"
            | "sponsorship"
            | "sponsorship.cancelled"
            | "sponsorship.created"
            | "sponsorship.edited"
            | "sponsorship.pending_cancellation"
            | "sponsorship.pending_tier_change"
            | "sponsorship.tier_changed"
            | "star"
            | "star.created"
            | "star.deleted"
            | "team"
            | "team.added_to_repository"
            | "team.created"
            | "team.deleted"
            | "team.edited"
            | "team.removed_from_repository"
            | "team_add"
            | "watch"
            | "watch.started"
            | "workflow_dispatch"
            | "workflow_job"
            | "workflow_job.completed"
            | "workflow_job.in_progress"
            | "workflow_job.queued"
            | "workflow_job.waiting"
            | "workflow_run"
            | "workflow_run.completed"
            | "workflow_run.in_progress"
            | "workflow_run.requested"
        ? EmitterWebhookEvent<K<K>>
        : never
}[Event]["payload"]

The webhook event payload

+

Accessors

isBot

  • get isBot(): boolean

  • Returns a boolean if the actor on the event was a bot.

    +

    Returns boolean

Methods

config

  • config<T>(fileName, defaultConfig?, deepMergeOptions?): Promise<null | T>

  • Reads the app configuration from the given YAML file in the .github directory of the repository.

    For example, given a file named .github/config.yml:

    close: true
@@ -43,25 +43,25 @@
  • OptionaldefaultConfig: T

    An object of default config options

  • OptionaldeepMergeOptions: Options

    Controls merging configs (from the deepmerge module)

Returns Promise<null | T>

Configuration object read from the file

-

issue

  • issue<T>(object?): RepoResultType<Event> & {
        issue_number: RepoIssueNumberType<Event>;
    } & T

  • Return the owner, repo, and issue_number params for making API requests +

issue

  • issue<T>(object?): RepoResultType<Event> & {
        issue_number: RepoIssueNumberType<Event>;
    } & T

  • Return the owner, repo, and issue_number params for making API requests against an issue. The object passed in will be merged with the repo params.

    const params = context.issue({body: 'Hello World!'})
    // Returns: {owner: 'username', repo: 'reponame', issue_number: 123, body: 'Hello World!'}

    Type Parameters

    • T

    Parameters

    • Optionalobject: T

      Params to be merged with the issue params.

      -

    Returns RepoResultType<Event> & {
        issue_number: RepoIssueNumberType<Event>;
    } & T

pullRequest

  • pullRequest<T>(object?): RepoResultType<Event> & {
        pull_number: RepoIssueNumberType<Event>;
    } & T

  • Return the owner, repo, and pull_number params for making API requests +

Returns RepoResultType<Event> & {
    issue_number: RepoIssueNumberType<Event>;
} & T

pullRequest

  • pullRequest<T>(object?): RepoResultType<Event> & {
        pull_number: RepoIssueNumberType<Event>;
    } & T

  • Return the owner, repo, and pull_number params for making API requests against a pull request. The object passed in will be merged with the repo params.

    const params = context.pullRequest({body: 'Hello World!'})
    // Returns: {owner: 'username', repo: 'reponame', pull_number: 123, body: 'Hello World!'}

    Type Parameters

    • T

    Parameters

    • Optionalobject: T

      Params to be merged with the pull request params.

      -

    Returns RepoResultType<Event> & {
        pull_number: RepoIssueNumberType<Event>;
    } & T

repo

  • repo<T>(object?): RepoResultType<Event> & T

  • Return the owner and repo params for making API requests against a +

Returns RepoResultType<Event> & {
    pull_number: RepoIssueNumberType<Event>;
} & T

repo

  • repo<T>(object?): RepoResultType<Event> & T

  • Return the owner and repo params for making API requests against a repository.

    const params = context.repo({path: '.github/config.yml'})
    // Returns: {owner: 'username', repo: 'reponame', path: '.github/config.yml'}

    Type Parameters

    • T

    Parameters

    • Optionalobject: T

      Params to be merged with the repo params.

      -

    Returns RepoResultType<Event> & T

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/api/13.3.7/classes/manifest_creation.ManifestCreation.html b/api/13.3.7/classes/manifest_creation.ManifestCreation.html index a228f3fcf54..d330fabb357 100644 --- a/api/13.3.7/classes/manifest_creation.ManifestCreation.html +++ b/api/13.3.7/classes/manifest_creation.ManifestCreation.html @@ -1,11 +1,11 @@ -ManifestCreation | probot

Class ManifestCreation

Constructors

constructor +ManifestCreation | probot

Class ManifestCreation

Constructors

constructor

Accessors

createAppUrl pkg

Methods

createAppFromCode createWebhookChannel getManifest updateEnv -

Constructors

constructor

Accessors

createAppUrl

pkg

Methods

createAppFromCode

  • createAppFromCode(code, probotOptions?): Promise<any>

  • Parameters

    • code: string
    • OptionalprobotOptions: OctokitOptions

    Returns Promise<any>

createWebhookChannel

getManifest

updateEnv

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
diff --git a/api/13.3.7/classes/probot.Probot.html b/api/13.3.7/classes/probot.Probot.html index 9b57adab6c4..c9bd81f3dd4 100644 --- a/api/13.3.7/classes/probot.Probot.html +++ b/api/13.3.7/classes/probot.Probot.html @@ -1,4 +1,4 @@ -Probot | probot

Class Probot

Constructors

constructor +Probot | probot

Class Probot

Constructors

constructor

Properties

auth log on @@ -11,7 +11,7 @@

Methods

load receive defaults -

Constructors

constructor

Properties

auth

auth: ((installationId?: number, log?: Logger) => Promise<Octokit & {} & {} & RestEndpointMethods & Api & API>)

log

log: Logger

on

on: (<E>(event: E | E[], callback: HandlerFunction<E, SimplifiedObject>) => void)

onAny

onAny: ((callback: ((event: EmitterWebhookEvent) => any)) => void)

onError

onError: ((callback: ((event: WebhookEventHandlerError<SimplifiedObject>) => any)) => void)

version

version: String

webhookPath

webhookPath: string

webhooks

webhooks: ProbotWebhooks

Staticversion

version: string = VERSION

Methods

load

receive

  • receive(event): Promise<void>

  • Parameters

    • event: EmitterWebhookEvent

    Returns Promise<void>

Staticdefaults

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/13.3.7/classes/server_server.Server.html b/api/13.3.7/classes/server_server.Server.html index fa9084fcf2e..d367d234c4a 100644 --- a/api/13.3.7/classes/server_server.Server.html +++ b/api/13.3.7/classes/server_server.Server.html @@ -1,4 +1,4 @@ -Server | probot

Class Server

Constructors

constructor +Server | probot

Class Server

Constructors

constructor

Properties

expressApp log probotApp @@ -8,7 +8,7 @@ router start stop -

Constructors

constructor

Properties

expressApp

expressApp: Application

log

log: Logger

probotApp

probotApp: Probot

version

version: string = VERSION

Staticversion

version: string = VERSION

Methods

load

router

start

  • start(): Promise<Server<typeof IncomingMessage, typeof ServerResponse>>

  • Returns Promise<Server<typeof IncomingMessage, typeof ServerResponse>>

stop

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/api/13.3.7/functions/apps_default.defaultApp.html b/api/13.3.7/functions/apps_default.defaultApp.html index fafb30b49e3..77d8c90ae7d 100644 --- a/api/13.3.7/functions/apps_default.defaultApp.html +++ b/api/13.3.7/functions/apps_default.defaultApp.html @@ -1,4 +1,4 @@ -defaultApp | probot

Function defaultApp

Settings

Member Visibility

Function defaultApp

Settings

Member Visibility
diff --git a/api/13.3.7/functions/apps_setup.setupAppFactory.html b/api/13.3.7/functions/apps_setup.setupAppFactory.html index f6d97834ae8..32f78470bbc 100644 --- a/api/13.3.7/functions/apps_setup.setupAppFactory.html +++ b/api/13.3.7/functions/apps_setup.setupAppFactory.html @@ -1,4 +1,4 @@ -setupAppFactory | probot

Function setupAppFactory

Settings

Member Visibility

Function setupAppFactory

Settings

Member Visibility
diff --git a/api/13.3.7/functions/auth.auth.html b/api/13.3.7/functions/auth.auth.html index a0f0deec577..c7571353e31 100644 --- a/api/13.3.7/functions/auth.auth.html +++ b/api/13.3.7/functions/auth.auth.html @@ -8,7 +8,7 @@

Parameters

  • state: State

    Probot application instance state, which is used to persist

  • OptionalinstallationId: number

Returns Promise<InstanceType<typeof ProbotOctokit>>

An authenticated GitHub API client

-

Settings

Member Visibility
diff --git a/api/13.3.7/functions/bin_read_cli_options.readCliOptions.html b/api/13.3.7/functions/bin_read_cli_options.readCliOptions.html index 43b5dec327c..7b62da23d85 100644 --- a/api/13.3.7/functions/bin_read_cli_options.readCliOptions.html +++ b/api/13.3.7/functions/bin_read_cli_options.readCliOptions.html @@ -1,4 +1,4 @@ -readCliOptions | probot

Function readCliOptions

Settings

Member Visibility

Function readCliOptions

Settings

Member Visibility
diff --git a/api/13.3.7/functions/bin_read_env_options.readEnvOptions.html b/api/13.3.7/functions/bin_read_env_options.readEnvOptions.html index ddfc5355177..8f91a7871f4 100644 --- a/api/13.3.7/functions/bin_read_env_options.readEnvOptions.html +++ b/api/13.3.7/functions/bin_read_env_options.readEnvOptions.html @@ -1,4 +1,4 @@ -readEnvOptions | probot

Function readEnvOptions

  • readEnvOptions(env?): {
        appId: number;
        args: never[];
        baseUrl: string;
        host: undefined | string;
        logFormat: "json" | "pretty";
        logLevel: LogLevel;
        logLevelInString: boolean;
        logMessageKey: undefined | string;
        port: number;
        privateKey: undefined | string;
        redisConfig: undefined | string;
        secret: undefined | string;
        sentryDsn: undefined | string;
        webhookPath: undefined | string;
        webhookProxy: undefined | string;
    }

  • Parameters

    • env: ProcessEnv = process.env

    Returns {
        appId: number;
        args: never[];
        baseUrl: string;
        host: undefined | string;
        logFormat: "json" | "pretty";
        logLevel: LogLevel;
        logLevelInString: boolean;
        logMessageKey: undefined | string;
        port: number;
        privateKey: undefined | string;
        redisConfig: undefined | string;
        secret: undefined | string;
        sentryDsn: undefined | string;
        webhookPath: undefined | string;
        webhookProxy: undefined | string;
    }

    • appId: number
    • args: never[]
    • baseUrl: string
    • host: undefined | string
    • logFormat: "json" | "pretty"
    • logLevel: LogLevel
    • logLevelInString: boolean
    • logMessageKey: undefined | string
    • port: number
    • privateKey: undefined | string
    • redisConfig: undefined | string
    • secret: undefined | string
    • sentryDsn: undefined | string
    • webhookPath: undefined | string
    • webhookProxy: undefined | string

Settings

Member Visibility

Function readEnvOptions

  • readEnvOptions(env?): {
        appId: number;
        args: never[];
        baseUrl: string;
        host: undefined | string;
        logFormat: "json" | "pretty";
        logLevel: LogLevel;
        logLevelInString: boolean;
        logMessageKey: undefined | string;
        port: number;
        privateKey: undefined | string;
        redisConfig: undefined | string;
        secret: undefined | string;
        sentryDsn: undefined | string;
        webhookPath: undefined | string;
        webhookProxy: undefined | string;
    }

  • Parameters

    • env: ProcessEnv = process.env

    Returns {
        appId: number;
        args: never[];
        baseUrl: string;
        host: undefined | string;
        logFormat: "json" | "pretty";
        logLevel: LogLevel;
        logLevelInString: boolean;
        logMessageKey: undefined | string;
        port: number;
        privateKey: undefined | string;
        redisConfig: undefined | string;
        secret: undefined | string;
        sentryDsn: undefined | string;
        webhookPath: undefined | string;
        webhookProxy: undefined | string;
    }

    • appId: number
    • args: never[]
    • baseUrl: string
    • host: undefined | string
    • logFormat: "json" | "pretty"
    • logLevel: LogLevel
    • logLevelInString: boolean
    • logMessageKey: undefined | string
    • port: number
    • privateKey: undefined | string
    • redisConfig: undefined | string
    • secret: undefined | string
    • sentryDsn: undefined | string
    • webhookPath: undefined | string
    • webhookProxy: undefined | string

Settings

Member Visibility
diff --git a/api/13.3.7/functions/create_node_middleware.createNodeMiddleware.html b/api/13.3.7/functions/create_node_middleware.createNodeMiddleware.html index 8eae3d5562c..76d2810b5fe 100644 --- a/api/13.3.7/functions/create_node_middleware.createNodeMiddleware.html +++ b/api/13.3.7/functions/create_node_middleware.createNodeMiddleware.html @@ -1,4 +1,4 @@ -createNodeMiddleware | probot

Function createNodeMiddleware

Settings

Member Visibility

Function createNodeMiddleware

Settings

Member Visibility
diff --git a/api/13.3.7/functions/create_probot.createProbot.html b/api/13.3.7/functions/create_probot.createProbot.html index b7a1ce036cb..cea8e06617c 100644 --- a/api/13.3.7/functions/create_probot.createProbot.html +++ b/api/13.3.7/functions/create_probot.createProbot.html @@ -1,7 +1,7 @@ createProbot | probot

Function createProbot

Settings

Member Visibility
diff --git a/api/13.3.7/functions/get_router.getRouter.html b/api/13.3.7/functions/get_router.getRouter.html index 85e47d13418..f08dc4ee4e4 100644 --- a/api/13.3.7/functions/get_router.getRouter.html +++ b/api/13.3.7/functions/get_router.getRouter.html @@ -2,7 +2,7 @@ expose HTTP endpoints

Parameters

  • router: Router
  • Optionalpath: string

    the prefix for the routes

Returns Router

an express.Router

-

Settings

Member Visibility
diff --git a/api/13.3.7/functions/helpers_get_error_handler.getErrorHandler.html b/api/13.3.7/functions/helpers_get_error_handler.getErrorHandler.html index 40cce541f15..abe69b2c978 100644 --- a/api/13.3.7/functions/helpers_get_error_handler.getErrorHandler.html +++ b/api/13.3.7/functions/helpers_get_error_handler.getErrorHandler.html @@ -1,4 +1,4 @@ -getErrorHandler | probot

Function getErrorHandler

  • getErrorHandler(log): ((error: Error & {
        event?: EmitterWebhookEvent;
    }) => void)

  • Parameters

    • log: Logger

    Returns ((error: Error & {
        event?: EmitterWebhookEvent;
    }) => void)

      • (error): void

      • Parameters

        • error: Error & {
              event?: EmitterWebhookEvent;
          }

        Returns void

Settings

Member Visibility

Function getErrorHandler

  • getErrorHandler(log): ((error: Error & {
        event?: EmitterWebhookEvent;
    }) => void)

  • Parameters

    • log: Logger

    Returns ((error: Error & {
        event?: EmitterWebhookEvent;
    }) => void)

      • (error): void

      • Parameters

        • error: Error & {
              event?: EmitterWebhookEvent;
          }

        Returns void

Settings

Member Visibility
diff --git a/api/13.3.7/functions/helpers_get_log.getLog.html b/api/13.3.7/functions/helpers_get_log.getLog.html index d54c48c2c7f..e99bf35b46f 100644 --- a/api/13.3.7/functions/helpers_get_log.getLog.html +++ b/api/13.3.7/functions/helpers_get_log.getLog.html @@ -1,4 +1,4 @@ -getLog | probot

Function getLog

Settings

Member Visibility

Function getLog

Settings

Member Visibility
diff --git a/api/13.3.7/functions/helpers_is_production.isProduction.html b/api/13.3.7/functions/helpers_is_production.isProduction.html index d070c2ed1ab..aa81a1652ac 100644 --- a/api/13.3.7/functions/helpers_is_production.isProduction.html +++ b/api/13.3.7/functions/helpers_is_production.isProduction.html @@ -1,4 +1,4 @@ -isProduction | probot

Function isProduction

Settings

Member Visibility

Function isProduction

Settings

Member Visibility
diff --git a/api/13.3.7/functions/helpers_is_supported_node_version.isSupportedNodeVersion.html b/api/13.3.7/functions/helpers_is_supported_node_version.isSupportedNodeVersion.html index c05c029100d..30a097ca42d 100644 --- a/api/13.3.7/functions/helpers_is_supported_node_version.isSupportedNodeVersion.html +++ b/api/13.3.7/functions/helpers_is_supported_node_version.isSupportedNodeVersion.html @@ -1,4 +1,4 @@ -isSupportedNodeVersion | probot

Function isSupportedNodeVersion

Settings

Member Visibility

Function isSupportedNodeVersion

Settings

Member Visibility
diff --git a/api/13.3.7/functions/helpers_load_package_json.loadPackageJson.html b/api/13.3.7/functions/helpers_load_package_json.loadPackageJson.html index 88c55e35d97..10b5916b1c8 100644 --- a/api/13.3.7/functions/helpers_load_package_json.loadPackageJson.html +++ b/api/13.3.7/functions/helpers_load_package_json.loadPackageJson.html @@ -1,4 +1,4 @@ -loadPackageJson | probot

Function loadPackageJson

Settings

Member Visibility

Function loadPackageJson

Settings

Member Visibility
diff --git a/api/13.3.7/functions/helpers_rebind_log.rebindLog.html b/api/13.3.7/functions/helpers_rebind_log.rebindLog.html index 7da8c96dbd6..30a601701fe 100644 --- a/api/13.3.7/functions/helpers_rebind_log.rebindLog.html +++ b/api/13.3.7/functions/helpers_rebind_log.rebindLog.html @@ -1,4 +1,4 @@ -rebindLog | probot

Function rebindLog

Settings

Member Visibility

Function rebindLog

Settings

Member Visibility
diff --git a/api/13.3.7/functions/helpers_resolve_app_function.resolveAppFunction.html b/api/13.3.7/functions/helpers_resolve_app_function.resolveAppFunction.html index ae3d6649d8e..d4c7bd81473 100644 --- a/api/13.3.7/functions/helpers_resolve_app_function.resolveAppFunction.html +++ b/api/13.3.7/functions/helpers_resolve_app_function.resolveAppFunction.html @@ -1,4 +1,4 @@ -resolveAppFunction | probot

Function resolveAppFunction

Settings

Member Visibility

Function resolveAppFunction

Settings

Member Visibility
diff --git a/api/13.3.7/functions/helpers_webhook_proxy.createWebhookProxy.html b/api/13.3.7/functions/helpers_webhook_proxy.createWebhookProxy.html index b2f79f6f3fd..cec97f7dd42 100644 --- a/api/13.3.7/functions/helpers_webhook_proxy.createWebhookProxy.html +++ b/api/13.3.7/functions/helpers_webhook_proxy.createWebhookProxy.html @@ -1,4 +1,4 @@ -createWebhookProxy | probot

Function createWebhookProxy

Settings

Member Visibility

Function createWebhookProxy

Settings

Member Visibility
diff --git a/api/13.3.7/functions/octokit_get_authenticated_octokit.getAuthenticatedOctokit.html b/api/13.3.7/functions/octokit_get_authenticated_octokit.getAuthenticatedOctokit.html index 973b0d08610..af26b7c64aa 100644 --- a/api/13.3.7/functions/octokit_get_authenticated_octokit.getAuthenticatedOctokit.html +++ b/api/13.3.7/functions/octokit_get_authenticated_octokit.getAuthenticatedOctokit.html @@ -1,4 +1,4 @@ -getAuthenticatedOctokit | probot

Function getAuthenticatedOctokit

  • getAuthenticatedOctokit(state, installationId?): Promise<Octokit & {} & {} & RestEndpointMethods & Api & API>

  • Parameters

    • state: State
    • OptionalinstallationId: number

    Returns Promise<Octokit & {} & {} & RestEndpointMethods & Api & API>

Settings

Member Visibility

Function getAuthenticatedOctokit

  • getAuthenticatedOctokit(state, installationId?): Promise<Octokit & {} & {} & RestEndpointMethods & Api & API>

  • Parameters

    • state: State
    • OptionalinstallationId: number

    Returns Promise<Octokit & {} & {} & RestEndpointMethods & Api & API>

Settings

Member Visibility
diff --git a/api/13.3.7/functions/octokit_get_octokit_throttle_options.getOctokitThrottleOptions.html b/api/13.3.7/functions/octokit_get_octokit_throttle_options.getOctokitThrottleOptions.html index 8f2e0b9443b..9eb87f75c33 100644 --- a/api/13.3.7/functions/octokit_get_octokit_throttle_options.getOctokitThrottleOptions.html +++ b/api/13.3.7/functions/octokit_get_octokit_throttle_options.getOctokitThrottleOptions.html @@ -1,4 +1,4 @@ -getOctokitThrottleOptions | probot

Function getOctokitThrottleOptions

Settings

Member Visibility

Function getOctokitThrottleOptions

Settings

Member Visibility
diff --git a/api/13.3.7/functions/octokit_get_probot_octokit_with_defaults.getProbotOctokitWithDefaults.html b/api/13.3.7/functions/octokit_get_probot_octokit_with_defaults.getProbotOctokitWithDefaults.html index 4647803f97f..a5289338123 100644 --- a/api/13.3.7/functions/octokit_get_probot_octokit_with_defaults.getProbotOctokitWithDefaults.html +++ b/api/13.3.7/functions/octokit_get_probot_octokit_with_defaults.getProbotOctokitWithDefaults.html @@ -5,7 +5,7 @@ deeply when instantiated.

Besides the authentication, the Octokit's baseUrl is set as well when run against a GitHub Enterprise Server with a custom domain.

-

Parameters

  • options: Options

Returns typeof Octokit & Constructor<{} & {} & RestEndpointMethods & Api & API>

Settings

Member Visibility
diff --git a/api/13.3.7/functions/octokit_get_webhooks.getWebhooks.html b/api/13.3.7/functions/octokit_get_webhooks.getWebhooks.html index f19ec555254..076cf187a7e 100644 --- a/api/13.3.7/functions/octokit_get_webhooks.getWebhooks.html +++ b/api/13.3.7/functions/octokit_get_webhooks.getWebhooks.html @@ -1,4 +1,4 @@ -getWebhooks | probot

Function getWebhooks

  • getWebhooks(state): Webhooks<Context<
        | "status"
        | "branch_protection_configuration"
        | "branch_protection_rule.disabled"
        | "branch_protection_rule.enabled"
        | "branch_protection_rule"
        | "branch_protection_rule.created"
        | "branch_protection_rule.deleted"
        | "branch_protection_rule.edited"
        | "check_run"
        | "check_run.completed"
        | "check_run.created"
        | "check_run.requested_action"
        | "check_run.rerequested"
        | "check_suite"
        | "check_suite.completed"
        | "check_suite.requested"
        | "check_suite.rerequested"
        | "code_scanning_alert"
        | "code_scanning_alert.appeared_in_branch"
        | "code_scanning_alert.closed_by_user"
        | "code_scanning_alert.created"
        | "code_scanning_alert.fixed"
        | "code_scanning_alert.reopened"
        | "code_scanning_alert.reopened_by_user"
        | "commit_comment"
        | "commit_comment.created"
        | "create"
        | "custom_property"
        | "custom_property.created"
        | "custom_property.deleted"
        | "custom_property_values"
        | "custom_property_values.updated"
        | "delete"
        | "dependabot_alert"
        | "dependabot_alert.created"
        | "dependabot_alert.dismissed"
        | "dependabot_alert.fixed"
        | "dependabot_alert.reintroduced"
        | "dependabot_alert.reopened"
        | "deploy_key"
        | "deploy_key.created"
        | "deploy_key.deleted"
        | "deployment"
        | "deployment.created"
        | "deployment_protection_rule"
        | "deployment_protection_rule.requested"
        | "deployment_review"
        | "deployment_review.approved"
        | "deployment_review.rejected"
        | "deployment_review.requested"
        | "deployment_status"
        | "deployment_status.created"
        | "discussion"
        | "discussion.answered"
        | "discussion.category_changed"
        | "discussion.created"
        | "discussion.deleted"
        | "discussion.edited"
        | "discussion.labeled"
        | "discussion.locked"
        | "discussion.pinned"
        | "discussion.transferred"
        | "discussion.unanswered"
        | "discussion.unlabeled"
        | "discussion.unlocked"
        | "discussion.unpinned"
        | "discussion_comment"
        | "discussion_comment.created"
        | "discussion_comment.deleted"
        | "discussion_comment.edited"
        | "fork"
        | "github_app_authorization"
        | "github_app_authorization.revoked"
        | "gollum"
        | "installation"
        | "installation.created"
        | "installation.deleted"
        | "installation.new_permissions_accepted"
        | "installation.suspend"
        | "installation.unsuspend"
        | "installation_repositories"
        | "installation_repositories.added"
        | "installation_repositories.removed"
        | "installation_target"
        | "installation_target.renamed"
        | "issue_comment"
        | "issue_comment.created"
        | "issue_comment.deleted"
        | "issue_comment.edited"
        | "issues"
        | "issues.assigned"
        | "issues.closed"
        | "issues.deleted"
        | "issues.demilestoned"
        | "issues.edited"
        | "issues.labeled"
        | "issues.locked"
        | "issues.milestoned"
        | "issues.opened"
        | "issues.pinned"
        | "issues.reopened"
        | "issues.transferred"
        | "issues.unassigned"
        | "issues.unlabeled"
        | "issues.unlocked"
        | "issues.unpinned"
        | "label"
        | "label.created"
        | "label.deleted"
        | "label.edited"
        | "marketplace_purchase"
        | "marketplace_purchase.cancelled"
        | "marketplace_purchase.changed"
        | "marketplace_purchase.pending_change"
        | "marketplace_purchase.pending_change_cancelled"
        | "marketplace_purchase.purchased"
        | "member"
        | "member.added"
        | "member.edited"
        | "member.removed"
        | "membership"
        | "membership.added"
        | "membership.removed"
        | "merge_group"
        | "merge_group.checks_requested"
        | "meta"
        | "meta.deleted"
        | "milestone"
        | "milestone.closed"
        | "milestone.created"
        | "milestone.deleted"
        | "milestone.edited"
        | "milestone.opened"
        | "org_block"
        | "org_block.blocked"
        | "org_block.unblocked"
        | "organization"
        | "organization.deleted"
        | "organization.member_added"
        | "organization.member_invited"
        | "organization.member_removed"
        | "organization.renamed"
        | "package"
        | "package.published"
        | "package.updated"
        | "page_build"
        | "ping"
        | "project"
        | "project.closed"
        | "project.created"
        | "project.deleted"
        | "project.edited"
        | "project.reopened"
        | "project_card"
        | "project_card.converted"
        | "project_card.created"
        | "project_card.deleted"
        | "project_card.edited"
        | "project_card.moved"
        | "project_column"
        | "project_column.created"
        | "project_column.deleted"
        | "project_column.edited"
        | "project_column.moved"
        | "projects_v2_item"
        | "projects_v2_item.archived"
        | "projects_v2_item.converted"
        | "projects_v2_item.created"
        | "projects_v2_item.deleted"
        | "projects_v2_item.edited"
        | "projects_v2_item.reordered"
        | "projects_v2_item.restored"
        | "public"
        | "pull_request"
        | "pull_request.assigned"
        | "pull_request.auto_merge_disabled"
        | "pull_request.auto_merge_enabled"
        | "pull_request.closed"
        | "pull_request.converted_to_draft"
        | "pull_request.demilestoned"
        | "pull_request.dequeued"
        | "pull_request.edited"
        | "pull_request.enqueued"
        | "pull_request.labeled"
        | "pull_request.locked"
        | "pull_request.milestoned"
        | "pull_request.opened"
        | "pull_request.ready_for_review"
        | "pull_request.reopened"
        | "pull_request.review_request_removed"
        | "pull_request.review_requested"
        | "pull_request.synchronize"
        | "pull_request.unassigned"
        | "pull_request.unlabeled"
        | "pull_request.unlocked"
        | "pull_request_review"
        | "pull_request_review.dismissed"
        | "pull_request_review.edited"
        | "pull_request_review.submitted"
        | "pull_request_review_comment"
        | "pull_request_review_comment.created"
        | "pull_request_review_comment.deleted"
        | "pull_request_review_comment.edited"
        | "pull_request_review_thread"
        | "pull_request_review_thread.resolved"
        | "pull_request_review_thread.unresolved"
        | "push"
        | "registry_package"
        | "registry_package.published"
        | "registry_package.updated"
        | "release"
        | "release.created"
        | "release.deleted"
        | "release.edited"
        | "release.prereleased"
        | "release.published"
        | "release.released"
        | "release.unpublished"
        | "repository"
        | "repository.archived"
        | "repository.created"
        | "repository.deleted"
        | "repository.edited"
        | "repository.privatized"
        | "repository.publicized"
        | "repository.renamed"
        | "repository.transferred"
        | "repository.unarchived"
        | "repository_dispatch"
        | "repository_import"
        | "repository_vulnerability_alert"
        | "repository_vulnerability_alert.create"
        | "repository_vulnerability_alert.dismiss"
        | "repository_vulnerability_alert.reopen"
        | "repository_vulnerability_alert.resolve"
        | "secret_scanning_alert"
        | "secret_scanning_alert.created"
        | "secret_scanning_alert.reopened"
        | "secret_scanning_alert.resolved"
        | "secret_scanning_alert.revoked"
        | "secret_scanning_alert_location"
        | "secret_scanning_alert_location.created"
        | "security_advisory"
        | "security_advisory.performed"
        | "security_advisory.published"
        | "security_advisory.updated"
        | "security_advisory.withdrawn"
        | "sponsorship"
        | "sponsorship.cancelled"
        | "sponsorship.created"
        | "sponsorship.edited"
        | "sponsorship.pending_cancellation"
        | "sponsorship.pending_tier_change"
        | "sponsorship.tier_changed"
        | "star"
        | "star.created"
        | "star.deleted"
        | "team"
        | "team.added_to_repository"
        | "team.created"
        | "team.deleted"
        | "team.edited"
        | "team.removed_from_repository"
        | "team_add"
        | "watch"
        | "watch.started"
        | "workflow_dispatch"
        | "workflow_job"
        | "workflow_job.completed"
        | "workflow_job.in_progress"
        | "workflow_job.queued"
        | "workflow_job.waiting"
        | "workflow_run"
        | "workflow_run.completed"
        | "workflow_run.in_progress"
        | "workflow_run.requested">>

  • Parameters

    Returns Webhooks<Context<
        | "status"
        | "branch_protection_configuration"
        | "branch_protection_rule.disabled"
        | "branch_protection_rule.enabled"
        | "branch_protection_rule"
        | "branch_protection_rule.created"
        | "branch_protection_rule.deleted"
        | "branch_protection_rule.edited"
        | "check_run"
        | "check_run.completed"
        | "check_run.created"
        | "check_run.requested_action"
        | "check_run.rerequested"
        | "check_suite"
        | "check_suite.completed"
        | "check_suite.requested"
        | "check_suite.rerequested"
        | "code_scanning_alert"
        | "code_scanning_alert.appeared_in_branch"
        | "code_scanning_alert.closed_by_user"
        | "code_scanning_alert.created"
        | "code_scanning_alert.fixed"
        | "code_scanning_alert.reopened"
        | "code_scanning_alert.reopened_by_user"
        | "commit_comment"
        | "commit_comment.created"
        | "create"
        | "custom_property"
        | "custom_property.created"
        | "custom_property.deleted"
        | "custom_property_values"
        | "custom_property_values.updated"
        | "delete"
        | "dependabot_alert"
        | "dependabot_alert.created"
        | "dependabot_alert.dismissed"
        | "dependabot_alert.fixed"
        | "dependabot_alert.reintroduced"
        | "dependabot_alert.reopened"
        | "deploy_key"
        | "deploy_key.created"
        | "deploy_key.deleted"
        | "deployment"
        | "deployment.created"
        | "deployment_protection_rule"
        | "deployment_protection_rule.requested"
        | "deployment_review"
        | "deployment_review.approved"
        | "deployment_review.rejected"
        | "deployment_review.requested"
        | "deployment_status"
        | "deployment_status.created"
        | "discussion"
        | "discussion.answered"
        | "discussion.category_changed"
        | "discussion.created"
        | "discussion.deleted"
        | "discussion.edited"
        | "discussion.labeled"
        | "discussion.locked"
        | "discussion.pinned"
        | "discussion.transferred"
        | "discussion.unanswered"
        | "discussion.unlabeled"
        | "discussion.unlocked"
        | "discussion.unpinned"
        | "discussion_comment"
        | "discussion_comment.created"
        | "discussion_comment.deleted"
        | "discussion_comment.edited"
        | "fork"
        | "github_app_authorization"
        | "github_app_authorization.revoked"
        | "gollum"
        | "installation"
        | "installation.created"
        | "installation.deleted"
        | "installation.new_permissions_accepted"
        | "installation.suspend"
        | "installation.unsuspend"
        | "installation_repositories"
        | "installation_repositories.added"
        | "installation_repositories.removed"
        | "installation_target"
        | "installation_target.renamed"
        | "issue_comment"
        | "issue_comment.created"
        | "issue_comment.deleted"
        | "issue_comment.edited"
        | "issues"
        | "issues.assigned"
        | "issues.closed"
        | "issues.deleted"
        | "issues.demilestoned"
        | "issues.edited"
        | "issues.labeled"
        | "issues.locked"
        | "issues.milestoned"
        | "issues.opened"
        | "issues.pinned"
        | "issues.reopened"
        | "issues.transferred"
        | "issues.unassigned"
        | "issues.unlabeled"
        | "issues.unlocked"
        | "issues.unpinned"
        | "label"
        | "label.created"
        | "label.deleted"
        | "label.edited"
        | "marketplace_purchase"
        | "marketplace_purchase.cancelled"
        | "marketplace_purchase.changed"
        | "marketplace_purchase.pending_change"
        | "marketplace_purchase.pending_change_cancelled"
        | "marketplace_purchase.purchased"
        | "member"
        | "member.added"
        | "member.edited"
        | "member.removed"
        | "membership"
        | "membership.added"
        | "membership.removed"
        | "merge_group"
        | "merge_group.checks_requested"
        | "meta"
        | "meta.deleted"
        | "milestone"
        | "milestone.closed"
        | "milestone.created"
        | "milestone.deleted"
        | "milestone.edited"
        | "milestone.opened"
        | "org_block"
        | "org_block.blocked"
        | "org_block.unblocked"
        | "organization"
        | "organization.deleted"
        | "organization.member_added"
        | "organization.member_invited"
        | "organization.member_removed"
        | "organization.renamed"
        | "package"
        | "package.published"
        | "package.updated"
        | "page_build"
        | "ping"
        | "project"
        | "project.closed"
        | "project.created"
        | "project.deleted"
        | "project.edited"
        | "project.reopened"
        | "project_card"
        | "project_card.converted"
        | "project_card.created"
        | "project_card.deleted"
        | "project_card.edited"
        | "project_card.moved"
        | "project_column"
        | "project_column.created"
        | "project_column.deleted"
        | "project_column.edited"
        | "project_column.moved"
        | "projects_v2_item"
        | "projects_v2_item.archived"
        | "projects_v2_item.converted"
        | "projects_v2_item.created"
        | "projects_v2_item.deleted"
        | "projects_v2_item.edited"
        | "projects_v2_item.reordered"
        | "projects_v2_item.restored"
        | "public"
        | "pull_request"
        | "pull_request.assigned"
        | "pull_request.auto_merge_disabled"
        | "pull_request.auto_merge_enabled"
        | "pull_request.closed"
        | "pull_request.converted_to_draft"
        | "pull_request.demilestoned"
        | "pull_request.dequeued"
        | "pull_request.edited"
        | "pull_request.enqueued"
        | "pull_request.labeled"
        | "pull_request.locked"
        | "pull_request.milestoned"
        | "pull_request.opened"
        | "pull_request.ready_for_review"
        | "pull_request.reopened"
        | "pull_request.review_request_removed"
        | "pull_request.review_requested"
        | "pull_request.synchronize"
        | "pull_request.unassigned"
        | "pull_request.unlabeled"
        | "pull_request.unlocked"
        | "pull_request_review"
        | "pull_request_review.dismissed"
        | "pull_request_review.edited"
        | "pull_request_review.submitted"
        | "pull_request_review_comment"
        | "pull_request_review_comment.created"
        | "pull_request_review_comment.deleted"
        | "pull_request_review_comment.edited"
        | "pull_request_review_thread"
        | "pull_request_review_thread.resolved"
        | "pull_request_review_thread.unresolved"
        | "push"
        | "registry_package"
        | "registry_package.published"
        | "registry_package.updated"
        | "release"
        | "release.created"
        | "release.deleted"
        | "release.edited"
        | "release.prereleased"
        | "release.published"
        | "release.released"
        | "release.unpublished"
        | "repository"
        | "repository.archived"
        | "repository.created"
        | "repository.deleted"
        | "repository.edited"
        | "repository.privatized"
        | "repository.publicized"
        | "repository.renamed"
        | "repository.transferred"
        | "repository.unarchived"
        | "repository_dispatch"
        | "repository_import"
        | "repository_vulnerability_alert"
        | "repository_vulnerability_alert.create"
        | "repository_vulnerability_alert.dismiss"
        | "repository_vulnerability_alert.reopen"
        | "repository_vulnerability_alert.resolve"
        | "secret_scanning_alert"
        | "secret_scanning_alert.created"
        | "secret_scanning_alert.reopened"
        | "secret_scanning_alert.resolved"
        | "secret_scanning_alert.revoked"
        | "secret_scanning_alert_location"
        | "secret_scanning_alert_location.created"
        | "security_advisory"
        | "security_advisory.performed"
        | "security_advisory.published"
        | "security_advisory.updated"
        | "security_advisory.withdrawn"
        | "sponsorship"
        | "sponsorship.cancelled"
        | "sponsorship.created"
        | "sponsorship.edited"
        | "sponsorship.pending_cancellation"
        | "sponsorship.pending_tier_change"
        | "sponsorship.tier_changed"
        | "star"
        | "star.created"
        | "star.deleted"
        | "team"
        | "team.added_to_repository"
        | "team.created"
        | "team.deleted"
        | "team.edited"
        | "team.removed_from_repository"
        | "team_add"
        | "watch"
        | "watch.started"
        | "workflow_dispatch"
        | "workflow_job"
        | "workflow_job.completed"
        | "workflow_job.in_progress"
        | "workflow_job.queued"
        | "workflow_job.waiting"
        | "workflow_run"
        | "workflow_run.completed"
        | "workflow_run.in_progress"
        | "workflow_run.requested">>

Settings

Member Visibility

Function getWebhooks

  • getWebhooks(state): Webhooks<Context<
        | "status"
        | "branch_protection_configuration"
        | "branch_protection_rule.disabled"
        | "branch_protection_rule.enabled"
        | "branch_protection_rule"
        | "branch_protection_rule.created"
        | "branch_protection_rule.deleted"
        | "branch_protection_rule.edited"
        | "check_run"
        | "check_run.completed"
        | "check_run.created"
        | "check_run.requested_action"
        | "check_run.rerequested"
        | "check_suite"
        | "check_suite.completed"
        | "check_suite.requested"
        | "check_suite.rerequested"
        | "code_scanning_alert"
        | "code_scanning_alert.appeared_in_branch"
        | "code_scanning_alert.closed_by_user"
        | "code_scanning_alert.created"
        | "code_scanning_alert.fixed"
        | "code_scanning_alert.reopened"
        | "code_scanning_alert.reopened_by_user"
        | "commit_comment"
        | "commit_comment.created"
        | "create"
        | "custom_property"
        | "custom_property.created"
        | "custom_property.deleted"
        | "custom_property_values"
        | "custom_property_values.updated"
        | "delete"
        | "dependabot_alert"
        | "dependabot_alert.created"
        | "dependabot_alert.dismissed"
        | "dependabot_alert.fixed"
        | "dependabot_alert.reintroduced"
        | "dependabot_alert.reopened"
        | "deploy_key"
        | "deploy_key.created"
        | "deploy_key.deleted"
        | "deployment"
        | "deployment.created"
        | "deployment_protection_rule"
        | "deployment_protection_rule.requested"
        | "deployment_review"
        | "deployment_review.approved"
        | "deployment_review.rejected"
        | "deployment_review.requested"
        | "deployment_status"
        | "deployment_status.created"
        | "discussion"
        | "discussion.answered"
        | "discussion.category_changed"
        | "discussion.created"
        | "discussion.deleted"
        | "discussion.edited"
        | "discussion.labeled"
        | "discussion.locked"
        | "discussion.pinned"
        | "discussion.transferred"
        | "discussion.unanswered"
        | "discussion.unlabeled"
        | "discussion.unlocked"
        | "discussion.unpinned"
        | "discussion_comment"
        | "discussion_comment.created"
        | "discussion_comment.deleted"
        | "discussion_comment.edited"
        | "fork"
        | "github_app_authorization"
        | "github_app_authorization.revoked"
        | "gollum"
        | "installation"
        | "installation.created"
        | "installation.deleted"
        | "installation.new_permissions_accepted"
        | "installation.suspend"
        | "installation.unsuspend"
        | "installation_repositories"
        | "installation_repositories.added"
        | "installation_repositories.removed"
        | "installation_target"
        | "installation_target.renamed"
        | "issue_comment"
        | "issue_comment.created"
        | "issue_comment.deleted"
        | "issue_comment.edited"
        | "issues"
        | "issues.assigned"
        | "issues.closed"
        | "issues.deleted"
        | "issues.demilestoned"
        | "issues.edited"
        | "issues.labeled"
        | "issues.locked"
        | "issues.milestoned"
        | "issues.opened"
        | "issues.pinned"
        | "issues.reopened"
        | "issues.transferred"
        | "issues.unassigned"
        | "issues.unlabeled"
        | "issues.unlocked"
        | "issues.unpinned"
        | "label"
        | "label.created"
        | "label.deleted"
        | "label.edited"
        | "marketplace_purchase"
        | "marketplace_purchase.cancelled"
        | "marketplace_purchase.changed"
        | "marketplace_purchase.pending_change"
        | "marketplace_purchase.pending_change_cancelled"
        | "marketplace_purchase.purchased"
        | "member"
        | "member.added"
        | "member.edited"
        | "member.removed"
        | "membership"
        | "membership.added"
        | "membership.removed"
        | "merge_group"
        | "merge_group.checks_requested"
        | "meta"
        | "meta.deleted"
        | "milestone"
        | "milestone.closed"
        | "milestone.created"
        | "milestone.deleted"
        | "milestone.edited"
        | "milestone.opened"
        | "org_block"
        | "org_block.blocked"
        | "org_block.unblocked"
        | "organization"
        | "organization.deleted"
        | "organization.member_added"
        | "organization.member_invited"
        | "organization.member_removed"
        | "organization.renamed"
        | "package"
        | "package.published"
        | "package.updated"
        | "page_build"
        | "ping"
        | "project"
        | "project.closed"
        | "project.created"
        | "project.deleted"
        | "project.edited"
        | "project.reopened"
        | "project_card"
        | "project_card.converted"
        | "project_card.created"
        | "project_card.deleted"
        | "project_card.edited"
        | "project_card.moved"
        | "project_column"
        | "project_column.created"
        | "project_column.deleted"
        | "project_column.edited"
        | "project_column.moved"
        | "projects_v2_item"
        | "projects_v2_item.archived"
        | "projects_v2_item.converted"
        | "projects_v2_item.created"
        | "projects_v2_item.deleted"
        | "projects_v2_item.edited"
        | "projects_v2_item.reordered"
        | "projects_v2_item.restored"
        | "public"
        | "pull_request"
        | "pull_request.assigned"
        | "pull_request.auto_merge_disabled"
        | "pull_request.auto_merge_enabled"
        | "pull_request.closed"
        | "pull_request.converted_to_draft"
        | "pull_request.demilestoned"
        | "pull_request.dequeued"
        | "pull_request.edited"
        | "pull_request.enqueued"
        | "pull_request.labeled"
        | "pull_request.locked"
        | "pull_request.milestoned"
        | "pull_request.opened"
        | "pull_request.ready_for_review"
        | "pull_request.reopened"
        | "pull_request.review_request_removed"
        | "pull_request.review_requested"
        | "pull_request.synchronize"
        | "pull_request.unassigned"
        | "pull_request.unlabeled"
        | "pull_request.unlocked"
        | "pull_request_review"
        | "pull_request_review.dismissed"
        | "pull_request_review.edited"
        | "pull_request_review.submitted"
        | "pull_request_review_comment"
        | "pull_request_review_comment.created"
        | "pull_request_review_comment.deleted"
        | "pull_request_review_comment.edited"
        | "pull_request_review_thread"
        | "pull_request_review_thread.resolved"
        | "pull_request_review_thread.unresolved"
        | "push"
        | "registry_package"
        | "registry_package.published"
        | "registry_package.updated"
        | "release"
        | "release.created"
        | "release.deleted"
        | "release.edited"
        | "release.prereleased"
        | "release.published"
        | "release.released"
        | "release.unpublished"
        | "repository"
        | "repository.archived"
        | "repository.created"
        | "repository.deleted"
        | "repository.edited"
        | "repository.privatized"
        | "repository.publicized"
        | "repository.renamed"
        | "repository.transferred"
        | "repository.unarchived"
        | "repository_dispatch"
        | "repository_import"
        | "repository_vulnerability_alert"
        | "repository_vulnerability_alert.create"
        | "repository_vulnerability_alert.dismiss"
        | "repository_vulnerability_alert.reopen"
        | "repository_vulnerability_alert.resolve"
        | "secret_scanning_alert"
        | "secret_scanning_alert.created"
        | "secret_scanning_alert.reopened"
        | "secret_scanning_alert.resolved"
        | "secret_scanning_alert.revoked"
        | "secret_scanning_alert_location"
        | "secret_scanning_alert_location.created"
        | "security_advisory"
        | "security_advisory.performed"
        | "security_advisory.published"
        | "security_advisory.updated"
        | "security_advisory.withdrawn"
        | "sponsorship"
        | "sponsorship.cancelled"
        | "sponsorship.created"
        | "sponsorship.edited"
        | "sponsorship.pending_cancellation"
        | "sponsorship.pending_tier_change"
        | "sponsorship.tier_changed"
        | "star"
        | "star.created"
        | "star.deleted"
        | "team"
        | "team.added_to_repository"
        | "team.created"
        | "team.deleted"
        | "team.edited"
        | "team.removed_from_repository"
        | "team_add"
        | "watch"
        | "watch.started"
        | "workflow_dispatch"
        | "workflow_job"
        | "workflow_job.completed"
        | "workflow_job.in_progress"
        | "workflow_job.queued"
        | "workflow_job.waiting"
        | "workflow_run"
        | "workflow_run.completed"
        | "workflow_run.in_progress"
        | "workflow_run.requested">>

  • Parameters

    Returns Webhooks<Context<
        | "status"
        | "branch_protection_configuration"
        | "branch_protection_rule.disabled"
        | "branch_protection_rule.enabled"
        | "branch_protection_rule"
        | "branch_protection_rule.created"
        | "branch_protection_rule.deleted"
        | "branch_protection_rule.edited"
        | "check_run"
        | "check_run.completed"
        | "check_run.created"
        | "check_run.requested_action"
        | "check_run.rerequested"
        | "check_suite"
        | "check_suite.completed"
        | "check_suite.requested"
        | "check_suite.rerequested"
        | "code_scanning_alert"
        | "code_scanning_alert.appeared_in_branch"
        | "code_scanning_alert.closed_by_user"
        | "code_scanning_alert.created"
        | "code_scanning_alert.fixed"
        | "code_scanning_alert.reopened"
        | "code_scanning_alert.reopened_by_user"
        | "commit_comment"
        | "commit_comment.created"
        | "create"
        | "custom_property"
        | "custom_property.created"
        | "custom_property.deleted"
        | "custom_property_values"
        | "custom_property_values.updated"
        | "delete"
        | "dependabot_alert"
        | "dependabot_alert.created"
        | "dependabot_alert.dismissed"
        | "dependabot_alert.fixed"
        | "dependabot_alert.reintroduced"
        | "dependabot_alert.reopened"
        | "deploy_key"
        | "deploy_key.created"
        | "deploy_key.deleted"
        | "deployment"
        | "deployment.created"
        | "deployment_protection_rule"
        | "deployment_protection_rule.requested"
        | "deployment_review"
        | "deployment_review.approved"
        | "deployment_review.rejected"
        | "deployment_review.requested"
        | "deployment_status"
        | "deployment_status.created"
        | "discussion"
        | "discussion.answered"
        | "discussion.category_changed"
        | "discussion.created"
        | "discussion.deleted"
        | "discussion.edited"
        | "discussion.labeled"
        | "discussion.locked"
        | "discussion.pinned"
        | "discussion.transferred"
        | "discussion.unanswered"
        | "discussion.unlabeled"
        | "discussion.unlocked"
        | "discussion.unpinned"
        | "discussion_comment"
        | "discussion_comment.created"
        | "discussion_comment.deleted"
        | "discussion_comment.edited"
        | "fork"
        | "github_app_authorization"
        | "github_app_authorization.revoked"
        | "gollum"
        | "installation"
        | "installation.created"
        | "installation.deleted"
        | "installation.new_permissions_accepted"
        | "installation.suspend"
        | "installation.unsuspend"
        | "installation_repositories"
        | "installation_repositories.added"
        | "installation_repositories.removed"
        | "installation_target"
        | "installation_target.renamed"
        | "issue_comment"
        | "issue_comment.created"
        | "issue_comment.deleted"
        | "issue_comment.edited"
        | "issues"
        | "issues.assigned"
        | "issues.closed"
        | "issues.deleted"
        | "issues.demilestoned"
        | "issues.edited"
        | "issues.labeled"
        | "issues.locked"
        | "issues.milestoned"
        | "issues.opened"
        | "issues.pinned"
        | "issues.reopened"
        | "issues.transferred"
        | "issues.unassigned"
        | "issues.unlabeled"
        | "issues.unlocked"
        | "issues.unpinned"
        | "label"
        | "label.created"
        | "label.deleted"
        | "label.edited"
        | "marketplace_purchase"
        | "marketplace_purchase.cancelled"
        | "marketplace_purchase.changed"
        | "marketplace_purchase.pending_change"
        | "marketplace_purchase.pending_change_cancelled"
        | "marketplace_purchase.purchased"
        | "member"
        | "member.added"
        | "member.edited"
        | "member.removed"
        | "membership"
        | "membership.added"
        | "membership.removed"
        | "merge_group"
        | "merge_group.checks_requested"
        | "meta"
        | "meta.deleted"
        | "milestone"
        | "milestone.closed"
        | "milestone.created"
        | "milestone.deleted"
        | "milestone.edited"
        | "milestone.opened"
        | "org_block"
        | "org_block.blocked"
        | "org_block.unblocked"
        | "organization"
        | "organization.deleted"
        | "organization.member_added"
        | "organization.member_invited"
        | "organization.member_removed"
        | "organization.renamed"
        | "package"
        | "package.published"
        | "package.updated"
        | "page_build"
        | "ping"
        | "project"
        | "project.closed"
        | "project.created"
        | "project.deleted"
        | "project.edited"
        | "project.reopened"
        | "project_card"
        | "project_card.converted"
        | "project_card.created"
        | "project_card.deleted"
        | "project_card.edited"
        | "project_card.moved"
        | "project_column"
        | "project_column.created"
        | "project_column.deleted"
        | "project_column.edited"
        | "project_column.moved"
        | "projects_v2_item"
        | "projects_v2_item.archived"
        | "projects_v2_item.converted"
        | "projects_v2_item.created"
        | "projects_v2_item.deleted"
        | "projects_v2_item.edited"
        | "projects_v2_item.reordered"
        | "projects_v2_item.restored"
        | "public"
        | "pull_request"
        | "pull_request.assigned"
        | "pull_request.auto_merge_disabled"
        | "pull_request.auto_merge_enabled"
        | "pull_request.closed"
        | "pull_request.converted_to_draft"
        | "pull_request.demilestoned"
        | "pull_request.dequeued"
        | "pull_request.edited"
        | "pull_request.enqueued"
        | "pull_request.labeled"
        | "pull_request.locked"
        | "pull_request.milestoned"
        | "pull_request.opened"
        | "pull_request.ready_for_review"
        | "pull_request.reopened"
        | "pull_request.review_request_removed"
        | "pull_request.review_requested"
        | "pull_request.synchronize"
        | "pull_request.unassigned"
        | "pull_request.unlabeled"
        | "pull_request.unlocked"
        | "pull_request_review"
        | "pull_request_review.dismissed"
        | "pull_request_review.edited"
        | "pull_request_review.submitted"
        | "pull_request_review_comment"
        | "pull_request_review_comment.created"
        | "pull_request_review_comment.deleted"
        | "pull_request_review_comment.edited"
        | "pull_request_review_thread"
        | "pull_request_review_thread.resolved"
        | "pull_request_review_thread.unresolved"
        | "push"
        | "registry_package"
        | "registry_package.published"
        | "registry_package.updated"
        | "release"
        | "release.created"
        | "release.deleted"
        | "release.edited"
        | "release.prereleased"
        | "release.published"
        | "release.released"
        | "release.unpublished"
        | "repository"
        | "repository.archived"
        | "repository.created"
        | "repository.deleted"
        | "repository.edited"
        | "repository.privatized"
        | "repository.publicized"
        | "repository.renamed"
        | "repository.transferred"
        | "repository.unarchived"
        | "repository_dispatch"
        | "repository_import"
        | "repository_vulnerability_alert"
        | "repository_vulnerability_alert.create"
        | "repository_vulnerability_alert.dismiss"
        | "repository_vulnerability_alert.reopen"
        | "repository_vulnerability_alert.resolve"
        | "secret_scanning_alert"
        | "secret_scanning_alert.created"
        | "secret_scanning_alert.reopened"
        | "secret_scanning_alert.resolved"
        | "secret_scanning_alert.revoked"
        | "secret_scanning_alert_location"
        | "secret_scanning_alert_location.created"
        | "security_advisory"
        | "security_advisory.performed"
        | "security_advisory.published"
        | "security_advisory.updated"
        | "security_advisory.withdrawn"
        | "sponsorship"
        | "sponsorship.cancelled"
        | "sponsorship.created"
        | "sponsorship.edited"
        | "sponsorship.pending_cancellation"
        | "sponsorship.pending_tier_change"
        | "sponsorship.tier_changed"
        | "star"
        | "star.created"
        | "star.deleted"
        | "team"
        | "team.added_to_repository"
        | "team.created"
        | "team.deleted"
        | "team.edited"
        | "team.removed_from_repository"
        | "team_add"
        | "watch"
        | "watch.started"
        | "workflow_dispatch"
        | "workflow_job"
        | "workflow_job.completed"
        | "workflow_job.in_progress"
        | "workflow_job.queued"
        | "workflow_job.waiting"
        | "workflow_run"
        | "workflow_run.completed"
        | "workflow_run.in_progress"
        | "workflow_run.requested">>

Settings

Member Visibility
diff --git a/api/13.3.7/functions/octokit_octokit_plugin_probot_request_logging.probotRequestLogging.html b/api/13.3.7/functions/octokit_octokit_plugin_probot_request_logging.probotRequestLogging.html index f86384d4986..0233108b907 100644 --- a/api/13.3.7/functions/octokit_octokit_plugin_probot_request_logging.probotRequestLogging.html +++ b/api/13.3.7/functions/octokit_octokit_plugin_probot_request_logging.probotRequestLogging.html @@ -1,4 +1,4 @@ -probotRequestLogging | probot

Function probotRequestLogging

Settings

Member Visibility

Function probotRequestLogging

Settings

Member Visibility
diff --git a/api/13.3.7/functions/octokit_octokit_webhooks_transform.webhookTransform.html b/api/13.3.7/functions/octokit_octokit_webhooks_transform.webhookTransform.html index cca9ab4992b..99a35ffc3a6 100644 --- a/api/13.3.7/functions/octokit_octokit_webhooks_transform.webhookTransform.html +++ b/api/13.3.7/functions/octokit_octokit_webhooks_transform.webhookTransform.html @@ -1,7 +1,7 @@ webhookTransform | probot

Function webhookTransform

  • webhookTransform(state, event): Promise<Context<
        | "status"
        | "branch_protection_configuration"
        | "branch_protection_rule.disabled"
        | "branch_protection_rule.enabled"
        | "branch_protection_rule"
        | "branch_protection_rule.created"
        | "branch_protection_rule.deleted"
        | "branch_protection_rule.edited"
        | "check_run"
        | "check_run.completed"
        | "check_run.created"
        | "check_run.requested_action"
        | "check_run.rerequested"
        | "check_suite"
        | "check_suite.completed"
        | "check_suite.requested"
        | "check_suite.rerequested"
        | "code_scanning_alert"
        | "code_scanning_alert.appeared_in_branch"
        | "code_scanning_alert.closed_by_user"
        | "code_scanning_alert.created"
        | "code_scanning_alert.fixed"
        | "code_scanning_alert.reopened"
        | "code_scanning_alert.reopened_by_user"
        | "commit_comment"
        | "commit_comment.created"
        | "create"
        | "custom_property"
        | "custom_property.created"
        | "custom_property.deleted"
        | "custom_property_values"
        | "custom_property_values.updated"
        | "delete"
        | "dependabot_alert"
        | "dependabot_alert.created"
        | "dependabot_alert.dismissed"
        | "dependabot_alert.fixed"
        | "dependabot_alert.reintroduced"
        | "dependabot_alert.reopened"
        | "deploy_key"
        | "deploy_key.created"
        | "deploy_key.deleted"
        | "deployment"
        | "deployment.created"
        | "deployment_protection_rule"
        | "deployment_protection_rule.requested"
        | "deployment_review"
        | "deployment_review.approved"
        | "deployment_review.rejected"
        | "deployment_review.requested"
        | "deployment_status"
        | "deployment_status.created"
        | "discussion"
        | "discussion.answered"
        | "discussion.category_changed"
        | "discussion.created"
        | "discussion.deleted"
        | "discussion.edited"
        | "discussion.labeled"
        | "discussion.locked"
        | "discussion.pinned"
        | "discussion.transferred"
        | "discussion.unanswered"
        | "discussion.unlabeled"
        | "discussion.unlocked"
        | "discussion.unpinned"
        | "discussion_comment"
        | "discussion_comment.created"
        | "discussion_comment.deleted"
        | "discussion_comment.edited"
        | "fork"
        | "github_app_authorization"
        | "github_app_authorization.revoked"
        | "gollum"
        | "installation"
        | "installation.created"
        | "installation.deleted"
        | "installation.new_permissions_accepted"
        | "installation.suspend"
        | "installation.unsuspend"
        | "installation_repositories"
        | "installation_repositories.added"
        | "installation_repositories.removed"
        | "installation_target"
        | "installation_target.renamed"
        | "issue_comment"
        | "issue_comment.created"
        | "issue_comment.deleted"
        | "issue_comment.edited"
        | "issues"
        | "issues.assigned"
        | "issues.closed"
        | "issues.deleted"
        | "issues.demilestoned"
        | "issues.edited"
        | "issues.labeled"
        | "issues.locked"
        | "issues.milestoned"
        | "issues.opened"
        | "issues.pinned"
        | "issues.reopened"
        | "issues.transferred"
        | "issues.unassigned"
        | "issues.unlabeled"
        | "issues.unlocked"
        | "issues.unpinned"
        | "label"
        | "label.created"
        | "label.deleted"
        | "label.edited"
        | "marketplace_purchase"
        | "marketplace_purchase.cancelled"
        | "marketplace_purchase.changed"
        | "marketplace_purchase.pending_change"
        | "marketplace_purchase.pending_change_cancelled"
        | "marketplace_purchase.purchased"
        | "member"
        | "member.added"
        | "member.edited"
        | "member.removed"
        | "membership"
        | "membership.added"
        | "membership.removed"
        | "merge_group"
        | "merge_group.checks_requested"
        | "meta"
        | "meta.deleted"
        | "milestone"
        | "milestone.closed"
        | "milestone.created"
        | "milestone.deleted"
        | "milestone.edited"
        | "milestone.opened"
        | "org_block"
        | "org_block.blocked"
        | "org_block.unblocked"
        | "organization"
        | "organization.deleted"
        | "organization.member_added"
        | "organization.member_invited"
        | "organization.member_removed"
        | "organization.renamed"
        | "package"
        | "package.published"
        | "package.updated"
        | "page_build"
        | "ping"
        | "project"
        | "project.closed"
        | "project.created"
        | "project.deleted"
        | "project.edited"
        | "project.reopened"
        | "project_card"
        | "project_card.converted"
        | "project_card.created"
        | "project_card.deleted"
        | "project_card.edited"
        | "project_card.moved"
        | "project_column"
        | "project_column.created"
        | "project_column.deleted"
        | "project_column.edited"
        | "project_column.moved"
        | "projects_v2_item"
        | "projects_v2_item.archived"
        | "projects_v2_item.converted"
        | "projects_v2_item.created"
        | "projects_v2_item.deleted"
        | "projects_v2_item.edited"
        | "projects_v2_item.reordered"
        | "projects_v2_item.restored"
        | "public"
        | "pull_request"
        | "pull_request.assigned"
        | "pull_request.auto_merge_disabled"
        | "pull_request.auto_merge_enabled"
        | "pull_request.closed"
        | "pull_request.converted_to_draft"
        | "pull_request.demilestoned"
        | "pull_request.dequeued"
        | "pull_request.edited"
        | "pull_request.enqueued"
        | "pull_request.labeled"
        | "pull_request.locked"
        | "pull_request.milestoned"
        | "pull_request.opened"
        | "pull_request.ready_for_review"
        | "pull_request.reopened"
        | "pull_request.review_request_removed"
        | "pull_request.review_requested"
        | "pull_request.synchronize"
        | "pull_request.unassigned"
        | "pull_request.unlabeled"
        | "pull_request.unlocked"
        | "pull_request_review"
        | "pull_request_review.dismissed"
        | "pull_request_review.edited"
        | "pull_request_review.submitted"
        | "pull_request_review_comment"
        | "pull_request_review_comment.created"
        | "pull_request_review_comment.deleted"
        | "pull_request_review_comment.edited"
        | "pull_request_review_thread"
        | "pull_request_review_thread.resolved"
        | "pull_request_review_thread.unresolved"
        | "push"
        | "registry_package"
        | "registry_package.published"
        | "registry_package.updated"
        | "release"
        | "release.created"
        | "release.deleted"
        | "release.edited"
        | "release.prereleased"
        | "release.published"
        | "release.released"
        | "release.unpublished"
        | "repository"
        | "repository.archived"
        | "repository.created"
        | "repository.deleted"
        | "repository.edited"
        | "repository.privatized"
        | "repository.publicized"
        | "repository.renamed"
        | "repository.transferred"
        | "repository.unarchived"
        | "repository_dispatch"
        | "repository_import"
        | "repository_vulnerability_alert"
        | "repository_vulnerability_alert.create"
        | "repository_vulnerability_alert.dismiss"
        | "repository_vulnerability_alert.reopen"
        | "repository_vulnerability_alert.resolve"
        | "secret_scanning_alert"
        | "secret_scanning_alert.created"
        | "secret_scanning_alert.reopened"
        | "secret_scanning_alert.resolved"
        | "secret_scanning_alert.revoked"
        | "secret_scanning_alert_location"
        | "secret_scanning_alert_location.created"
        | "security_advisory"
        | "security_advisory.performed"
        | "security_advisory.published"
        | "security_advisory.updated"
        | "security_advisory.withdrawn"
        | "sponsorship"
        | "sponsorship.cancelled"
        | "sponsorship.created"
        | "sponsorship.edited"
        | "sponsorship.pending_cancellation"
        | "sponsorship.pending_tier_change"
        | "sponsorship.tier_changed"
        | "star"
        | "star.created"
        | "star.deleted"
        | "team"
        | "team.added_to_repository"
        | "team.created"
        | "team.deleted"
        | "team.edited"
        | "team.removed_from_repository"
        | "team_add"
        | "watch"
        | "watch.started"
        | "workflow_dispatch"
        | "workflow_job"
        | "workflow_job.completed"
        | "workflow_job.in_progress"
        | "workflow_job.queued"
        | "workflow_job.waiting"
        | "workflow_run"
        | "workflow_run.completed"
        | "workflow_run.in_progress"
        | "workflow_run.requested">>

  • Probot's transform option, which extends the event object that is passed to webhook event handlers by @octokit/webhooks

    Parameters

    • state: State
    • event: EmitterWebhookEvent

    Returns Promise<Context<
        | "status"
        | "branch_protection_configuration"
        | "branch_protection_rule.disabled"
        | "branch_protection_rule.enabled"
        | "branch_protection_rule"
        | "branch_protection_rule.created"
        | "branch_protection_rule.deleted"
        | "branch_protection_rule.edited"
        | "check_run"
        | "check_run.completed"
        | "check_run.created"
        | "check_run.requested_action"
        | "check_run.rerequested"
        | "check_suite"
        | "check_suite.completed"
        | "check_suite.requested"
        | "check_suite.rerequested"
        | "code_scanning_alert"
        | "code_scanning_alert.appeared_in_branch"
        | "code_scanning_alert.closed_by_user"
        | "code_scanning_alert.created"
        | "code_scanning_alert.fixed"
        | "code_scanning_alert.reopened"
        | "code_scanning_alert.reopened_by_user"
        | "commit_comment"
        | "commit_comment.created"
        | "create"
        | "custom_property"
        | "custom_property.created"
        | "custom_property.deleted"
        | "custom_property_values"
        | "custom_property_values.updated"
        | "delete"
        | "dependabot_alert"
        | "dependabot_alert.created"
        | "dependabot_alert.dismissed"
        | "dependabot_alert.fixed"
        | "dependabot_alert.reintroduced"
        | "dependabot_alert.reopened"
        | "deploy_key"
        | "deploy_key.created"
        | "deploy_key.deleted"
        | "deployment"
        | "deployment.created"
        | "deployment_protection_rule"
        | "deployment_protection_rule.requested"
        | "deployment_review"
        | "deployment_review.approved"
        | "deployment_review.rejected"
        | "deployment_review.requested"
        | "deployment_status"
        | "deployment_status.created"
        | "discussion"
        | "discussion.answered"
        | "discussion.category_changed"
        | "discussion.created"
        | "discussion.deleted"
        | "discussion.edited"
        | "discussion.labeled"
        | "discussion.locked"
        | "discussion.pinned"
        | "discussion.transferred"
        | "discussion.unanswered"
        | "discussion.unlabeled"
        | "discussion.unlocked"
        | "discussion.unpinned"
        | "discussion_comment"
        | "discussion_comment.created"
        | "discussion_comment.deleted"
        | "discussion_comment.edited"
        | "fork"
        | "github_app_authorization"
        | "github_app_authorization.revoked"
        | "gollum"
        | "installation"
        | "installation.created"
        | "installation.deleted"
        | "installation.new_permissions_accepted"
        | "installation.suspend"
        | "installation.unsuspend"
        | "installation_repositories"
        | "installation_repositories.added"
        | "installation_repositories.removed"
        | "installation_target"
        | "installation_target.renamed"
        | "issue_comment"
        | "issue_comment.created"
        | "issue_comment.deleted"
        | "issue_comment.edited"
        | "issues"
        | "issues.assigned"
        | "issues.closed"
        | "issues.deleted"
        | "issues.demilestoned"
        | "issues.edited"
        | "issues.labeled"
        | "issues.locked"
        | "issues.milestoned"
        | "issues.opened"
        | "issues.pinned"
        | "issues.reopened"
        | "issues.transferred"
        | "issues.unassigned"
        | "issues.unlabeled"
        | "issues.unlocked"
        | "issues.unpinned"
        | "label"
        | "label.created"
        | "label.deleted"
        | "label.edited"
        | "marketplace_purchase"
        | "marketplace_purchase.cancelled"
        | "marketplace_purchase.changed"
        | "marketplace_purchase.pending_change"
        | "marketplace_purchase.pending_change_cancelled"
        | "marketplace_purchase.purchased"
        | "member"
        | "member.added"
        | "member.edited"
        | "member.removed"
        | "membership"
        | "membership.added"
        | "membership.removed"
        | "merge_group"
        | "merge_group.checks_requested"
        | "meta"
        | "meta.deleted"
        | "milestone"
        | "milestone.closed"
        | "milestone.created"
        | "milestone.deleted"
        | "milestone.edited"
        | "milestone.opened"
        | "org_block"
        | "org_block.blocked"
        | "org_block.unblocked"
        | "organization"
        | "organization.deleted"
        | "organization.member_added"
        | "organization.member_invited"
        | "organization.member_removed"
        | "organization.renamed"
        | "package"
        | "package.published"
        | "package.updated"
        | "page_build"
        | "ping"
        | "project"
        | "project.closed"
        | "project.created"
        | "project.deleted"
        | "project.edited"
        | "project.reopened"
        | "project_card"
        | "project_card.converted"
        | "project_card.created"
        | "project_card.deleted"
        | "project_card.edited"
        | "project_card.moved"
        | "project_column"
        | "project_column.created"
        | "project_column.deleted"
        | "project_column.edited"
        | "project_column.moved"
        | "projects_v2_item"
        | "projects_v2_item.archived"
        | "projects_v2_item.converted"
        | "projects_v2_item.created"
        | "projects_v2_item.deleted"
        | "projects_v2_item.edited"
        | "projects_v2_item.reordered"
        | "projects_v2_item.restored"
        | "public"
        | "pull_request"
        | "pull_request.assigned"
        | "pull_request.auto_merge_disabled"
        | "pull_request.auto_merge_enabled"
        | "pull_request.closed"
        | "pull_request.converted_to_draft"
        | "pull_request.demilestoned"
        | "pull_request.dequeued"
        | "pull_request.edited"
        | "pull_request.enqueued"
        | "pull_request.labeled"
        | "pull_request.locked"
        | "pull_request.milestoned"
        | "pull_request.opened"
        | "pull_request.ready_for_review"
        | "pull_request.reopened"
        | "pull_request.review_request_removed"
        | "pull_request.review_requested"
        | "pull_request.synchronize"
        | "pull_request.unassigned"
        | "pull_request.unlabeled"
        | "pull_request.unlocked"
        | "pull_request_review"
        | "pull_request_review.dismissed"
        | "pull_request_review.edited"
        | "pull_request_review.submitted"
        | "pull_request_review_comment"
        | "pull_request_review_comment.created"
        | "pull_request_review_comment.deleted"
        | "pull_request_review_comment.edited"
        | "pull_request_review_thread"
        | "pull_request_review_thread.resolved"
        | "pull_request_review_thread.unresolved"
        | "push"
        | "registry_package"
        | "registry_package.published"
        | "registry_package.updated"
        | "release"
        | "release.created"
        | "release.deleted"
        | "release.edited"
        | "release.prereleased"
        | "release.published"
        | "release.released"
        | "release.unpublished"
        | "repository"
        | "repository.archived"
        | "repository.created"
        | "repository.deleted"
        | "repository.edited"
        | "repository.privatized"
        | "repository.publicized"
        | "repository.renamed"
        | "repository.transferred"
        | "repository.unarchived"
        | "repository_dispatch"
        | "repository_import"
        | "repository_vulnerability_alert"
        | "repository_vulnerability_alert.create"
        | "repository_vulnerability_alert.dismiss"
        | "repository_vulnerability_alert.reopen"
        | "repository_vulnerability_alert.resolve"
        | "secret_scanning_alert"
        | "secret_scanning_alert.created"
        | "secret_scanning_alert.reopened"
        | "secret_scanning_alert.resolved"
        | "secret_scanning_alert.revoked"
        | "secret_scanning_alert_location"
        | "secret_scanning_alert_location.created"
        | "security_advisory"
        | "security_advisory.performed"
        | "security_advisory.published"
        | "security_advisory.updated"
        | "security_advisory.withdrawn"
        | "sponsorship"
        | "sponsorship.cancelled"
        | "sponsorship.created"
        | "sponsorship.edited"
        | "sponsorship.pending_cancellation"
        | "sponsorship.pending_tier_change"
        | "sponsorship.tier_changed"
        | "star"
        | "star.created"
        | "star.deleted"
        | "team"
        | "team.added_to_repository"
        | "team.created"
        | "team.deleted"
        | "team.edited"
        | "team.removed_from_repository"
        | "team_add"
        | "watch"
        | "watch.started"
        | "workflow_dispatch"
        | "workflow_job"
        | "workflow_job.completed"
        | "workflow_job.in_progress"
        | "workflow_job.queued"
        | "workflow_job.waiting"
        | "workflow_run"
        | "workflow_run.completed"
        | "workflow_run.in_progress"
        | "workflow_run.requested">>

    See

    https://github.com/octokit/webhooks.js/#constructor

    -

Settings

Member Visibility
diff --git a/api/13.3.7/functions/run.run.html b/api/13.3.7/functions/run.run.html index 621659837f2..3e0f64970a6 100644 --- a/api/13.3.7/functions/run.run.html +++ b/api/13.3.7/functions/run.run.html @@ -1,5 +1,5 @@ run | probot

Function run

  • run(appFnOrArgv, additionalOptions?): Promise<Server>

  • Parameters

    • appFnOrArgv: string[] | ApplicationFunction

      set to either a probot application function: (app) => { ... } or to process.argv

      -
    • OptionaladditionalOptions: AdditionalOptions

    Returns Promise<Server>

Settings

Member Visibility
diff --git a/api/13.3.7/functions/server_logging_middleware.getLoggingMiddleware.html b/api/13.3.7/functions/server_logging_middleware.getLoggingMiddleware.html index 5d3be07b0fe..98af53d21c9 100644 --- a/api/13.3.7/functions/server_logging_middleware.getLoggingMiddleware.html +++ b/api/13.3.7/functions/server_logging_middleware.getLoggingMiddleware.html @@ -1,4 +1,4 @@ -getLoggingMiddleware | probot

Function getLoggingMiddleware

  • getLoggingMiddleware(logger, options?): HttpLogger

  • Parameters

    • logger: Logger
    • Optionaloptions: Options<IncomingMessage, ServerResponse<IncomingMessage>, never>

    Returns HttpLogger

Settings

Member Visibility

Function getLoggingMiddleware

  • getLoggingMiddleware(logger, options?): HttpLogger

  • Parameters

    • logger: Logger
    • Optionaloptions: Options<IncomingMessage, ServerResponse<IncomingMessage>, never>

    Returns HttpLogger

Settings

Member Visibility
diff --git a/api/13.3.7/functions/views_import.importView.html b/api/13.3.7/functions/views_import.importView.html index 362860a485e..aa86d0ddc6f 100644 --- a/api/13.3.7/functions/views_import.importView.html +++ b/api/13.3.7/functions/views_import.importView.html @@ -1,4 +1,4 @@ -importView | probot

Function importView

  • importView(__namedParameters): string

  • Parameters

    • __namedParameters: {
          GH_HOST: string;
          WEBHOOK_PROXY_URL?: string;
          name?: string;
      }
      • GH_HOST: string
      • OptionalWEBHOOK_PROXY_URL?: string
      • Optionalname?: string

    Returns string

Settings

Member Visibility

Function importView

  • importView(__namedParameters): string

  • Parameters

    • __namedParameters: {
          GH_HOST: string;
          WEBHOOK_PROXY_URL?: string;
          name?: string;
      }
      • GH_HOST: string
      • OptionalWEBHOOK_PROXY_URL?: string
      • Optionalname?: string

    Returns string

Settings

Member Visibility
diff --git a/api/13.3.7/functions/views_probot.probotView.html b/api/13.3.7/functions/views_probot.probotView.html index ef776db2dec..6bddb3a8d4c 100644 --- a/api/13.3.7/functions/views_probot.probotView.html +++ b/api/13.3.7/functions/views_probot.probotView.html @@ -1,4 +1,4 @@ -probotView | probot

Function probotView

  • probotView(__namedParameters): string

  • Parameters

    • __namedParameters: {
          description?: string;
          name?: string;
          version?: string;
      }
      • Optionaldescription?: string
      • Optionalname?: string
      • Optionalversion?: string

    Returns string

Settings

Member Visibility

Function probotView

  • probotView(__namedParameters): string

  • Parameters

    • __namedParameters: {
          description?: string;
          name?: string;
          version?: string;
      }
      • Optionaldescription?: string
      • Optionalname?: string
      • Optionalversion?: string

    Returns string

Settings

Member Visibility
diff --git a/api/13.3.7/functions/views_setup.setupView.html b/api/13.3.7/functions/views_setup.setupView.html index e93f3278add..e6a0c28317a 100644 --- a/api/13.3.7/functions/views_setup.setupView.html +++ b/api/13.3.7/functions/views_setup.setupView.html @@ -1,4 +1,4 @@ -setupView | probot

Function setupView

  • setupView(__namedParameters): string

  • Parameters

    • __namedParameters: {
          createAppUrl: string;
          description?: string;
          manifest: string;
          name?: string;
          version?: string;
      }
      • createAppUrl: string
      • Optionaldescription?: string
      • manifest: string
      • Optionalname?: string
      • Optionalversion?: string

    Returns string

Settings

Member Visibility

Function setupView

  • setupView(__namedParameters): string

  • Parameters

    • __namedParameters: {
          createAppUrl: string;
          description?: string;
          manifest: string;
          name?: string;
          version?: string;
      }
      • createAppUrl: string
      • Optionaldescription?: string
      • manifest: string
      • Optionalname?: string
      • Optionalversion?: string

    Returns string

Settings

Member Visibility
diff --git a/api/13.3.7/functions/views_success.successView.html b/api/13.3.7/functions/views_success.successView.html index 932dba4bed2..f1a771e5253 100644 --- a/api/13.3.7/functions/views_success.successView.html +++ b/api/13.3.7/functions/views_success.successView.html @@ -1,4 +1,4 @@ -successView | probot

Function successView

  • successView(__namedParameters): string

  • Parameters

    • __namedParameters: {
          name?: string;
      }
      • Optionalname?: string

    Returns string

Settings

Member Visibility

Function successView

  • successView(__namedParameters): string

  • Parameters

    • __namedParameters: {
          name?: string;
      }
      • Optionalname?: string

    Returns string

Settings

Member Visibility
diff --git a/api/13.3.7/interfaces/helpers_resolve_app_function.ResolveOptions.html b/api/13.3.7/interfaces/helpers_resolve_app_function.ResolveOptions.html index 894bd9f91e4..d4e49c01ae2 100644 --- a/api/13.3.7/interfaces/helpers_resolve_app_function.ResolveOptions.html +++ b/api/13.3.7/interfaces/helpers_resolve_app_function.ResolveOptions.html @@ -1,6 +1,6 @@ -ResolveOptions | probot

Interface ResolveOptions

interface ResolveOptions {
    basedir?: string;
    resolver?: RequireResolve;
}

Properties

basedir? +ResolveOptions | probot

Interface ResolveOptions

interface ResolveOptions {
    basedir?: string;
    resolver?: RequireResolve;
}

Properties

basedir? resolver? -

Properties

Optionalbasedir

basedir?: string

Optionalresolver

resolver?: RequireResolve

Settings

Member Visibility

On This Page

Properties
diff --git a/api/13.3.7/interfaces/helpers_webhook_proxy.WebhookProxyOptions.html b/api/13.3.7/interfaces/helpers_webhook_proxy.WebhookProxyOptions.html index e75579a01ce..df88d4d6346 100644 --- a/api/13.3.7/interfaces/helpers_webhook_proxy.WebhookProxyOptions.html +++ b/api/13.3.7/interfaces/helpers_webhook_proxy.WebhookProxyOptions.html @@ -1,9 +1,9 @@ -WebhookProxyOptions | probot

Interface WebhookProxyOptions

interface WebhookProxyOptions {
    fetch?: Function;
    logger: Logger;
    path?: string;
    port?: number;
    url: string;
}

Properties

fetch? +WebhookProxyOptions | probot

Interface WebhookProxyOptions

interface WebhookProxyOptions {
    fetch?: Function;
    logger: Logger;
    path?: string;
    port?: number;
    url: string;
}

Properties

fetch? logger path? port? url -

Properties

Optionalfetch

fetch?: Function

logger

logger: Logger

Optionalpath

path?: string

Optionalport

port?: number

url

url: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/13.3.7/interfaces/types.Options.html b/api/13.3.7/interfaces/types.Options.html index 1c8eda59594..ed2d209c9c2 100644 --- a/api/13.3.7/interfaces/types.Options.html +++ b/api/13.3.7/interfaces/types.Options.html @@ -1,4 +1,4 @@ -Options | probot

Interface Options

interface Options {
    Octokit?: typeof Octokit & Constructor<{} & {} & RestEndpointMethods & Api & API>;
    appId?: string | number;
    baseUrl?: string;
    githubToken?: string;
    host?: string;
    log?: Logger;
    logLevel?:
        | "fatal"
        | "error"
        | "warn"
        | "info"
        | "debug"
        | "trace";
    logMessageKey?: string;
    port?: number;
    privateKey?: string;
    redisConfig?: string | RedisOptions;
    request?: RequestRequestOptions;
    secret?: string;
    webhookPath?: string;
}

Properties

Octokit? +Options | probot

Interface Options

interface Options {
    Octokit?: typeof Octokit & Constructor<{} & {} & RestEndpointMethods & Api & API>;
    appId?: string | number;
    baseUrl?: string;
    githubToken?: string;
    host?: string;
    log?: Logger;
    logLevel?:
        | "fatal"
        | "error"
        | "warn"
        | "info"
        | "debug"
        | "trace";
    logMessageKey?: string;
    port?: number;
    privateKey?: string;
    redisConfig?: string | RedisOptions;
    request?: RequestRequestOptions;
    secret?: string;
    webhookPath?: string;
}

Properties

Octokit? appId? baseUrl? githubToken? @@ -12,7 +12,7 @@ request? secret? webhookPath? -

Properties

OptionalOctokit

Octokit?: typeof Octokit & Constructor<{} & {} & RestEndpointMethods & Api & API>

OptionalappId

appId?: string | number

OptionalbaseUrl

baseUrl?: string

OptionalgithubToken

githubToken?: string

Optionalhost

host?: string

Optionallog

log?: Logger

OptionallogLevel

logLevel?:
    | "fatal"
    | "error"
    | "warn"
    | "info"
    | "debug"
    | "trace"

OptionallogMessageKey

logMessageKey?: string

Optionalport

port?: number

OptionalprivateKey

privateKey?: string

OptionalredisConfig

redisConfig?: string | RedisOptions

Optionalrequest

request?: RequestRequestOptions

Optionalsecret

secret?: string

OptionalwebhookPath

webhookPath?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/api/13.3.7/modules/apps_default.html b/api/13.3.7/modules/apps_default.html index 20e5abd45cf..a56bccd356c 100644 --- a/api/13.3.7/modules/apps_default.html +++ b/api/13.3.7/modules/apps_default.html @@ -1,4 +1,4 @@ -apps/default | probot

Module apps/default

Index

Functions

defaultApp +apps/default | probot

Module apps/default

Index

Functions

defaultApp

Settings

Member Visibility

Module apps/setup

Index

Functions

setupAppFactory +apps/setup | probot

Module apps/setup

Index

Functions

setupAppFactory

Settings

Member Visibility

Module auth

Index

Functions

auth +auth | probot

Module auth

Index

Functions

auth

Settings

Member Visibility

Module bin/probot

Settings

Member Visibility

Module bin/probot

Settings

Member Visibility
diff --git a/api/13.3.7/modules/bin_probot_receive.html b/api/13.3.7/modules/bin_probot_receive.html index 022d1e97bde..f0bcb5f7f50 100644 --- a/api/13.3.7/modules/bin_probot_receive.html +++ b/api/13.3.7/modules/bin_probot_receive.html @@ -1,4 +1,4 @@ -bin/probot-receive | probot

Module bin/probot-receive

Settings

Member Visibility

Module bin/probot-receive

Settings

Member Visibility
diff --git a/api/13.3.7/modules/bin_probot_run.html b/api/13.3.7/modules/bin_probot_run.html index 3ee65561dae..35ee28d3347 100644 --- a/api/13.3.7/modules/bin_probot_run.html +++ b/api/13.3.7/modules/bin_probot_run.html @@ -1,4 +1,4 @@ -bin/probot-run | probot

Module bin/probot-run

Settings

Member Visibility

Module bin/probot-run

Settings

Member Visibility
diff --git a/api/13.3.7/modules/bin_read_cli_options.html b/api/13.3.7/modules/bin_read_cli_options.html index 5696e062eee..148bd3322e2 100644 --- a/api/13.3.7/modules/bin_read_cli_options.html +++ b/api/13.3.7/modules/bin_read_cli_options.html @@ -1,4 +1,4 @@ -bin/read-cli-options | probot

Module bin/read-cli-options

Index

Functions

readCliOptions +bin/read-cli-options | probot

Module bin/read-cli-options

Index

Functions

readCliOptions

Settings

Member Visibility

Module bin/read-env-options

Index

Functions

readEnvOptions +bin/read-env-options | probot

Module bin/read-env-options

Index

Functions

readEnvOptions

Settings

Member Visibility

Module context

Index

Classes

Context +context | probot

Module context

Index

Classes

Context

Type Aliases

MergeOptions

Settings

Member Visibility

Module create-node-middleware

Index

Functions

createNodeMiddleware +create-node-middleware | probot

Module create-node-middleware

Index

Functions

createNodeMiddleware

Settings

Member Visibility

Module create-probot

Index

Functions

createProbot +create-probot | probot

Module create-probot

Index

Functions

createProbot

Settings

Member Visibility

Module get-router

Index

Functions

getRouter +get-router | probot

Module get-router

Index

Functions

getRouter

Settings

Member Visibility

Module helpers/get-error-handler

Index

Functions

getErrorHandler +helpers/get-error-handler | probot

Module helpers/get-error-handler

Index

Functions

getErrorHandler

Settings

Member Visibility

Module helpers/get-log

Index

Type Aliases

GetLogOptions +helpers/get-log | probot

Module helpers/get-log

Index

Type Aliases

GetLogOptions

Functions

getLog

Settings

Member Visibility

Module helpers/is-production

Index

Functions

isProduction +helpers/is-production | probot

Module helpers/is-production

Index

Functions

isProduction

Settings

Member Visibility

Module helpers/is-supported-node-version

Index

Functions

isSupportedNodeVersion +helpers/is-supported-node-version | probot

Module helpers/is-supported-node-version

Index

Functions

isSupportedNodeVersion

Settings

Member Visibility

Module helpers/load-package-json

Index

Functions

loadPackageJson +helpers/load-package-json | probot

Module helpers/load-package-json

Index

Functions

loadPackageJson

Settings

Member Visibility

Module helpers/rebind-log

Index

Functions

rebindLog +helpers/rebind-log | probot

Module helpers/rebind-log

Index

Functions

rebindLog

Settings

Member Visibility

Module helpers/resolve-app-function

Index

Interfaces

ResolveOptions +helpers/resolve-app-function | probot

Module helpers/resolve-app-function

Index

Interfaces

ResolveOptions

Functions

resolveAppFunction

Settings

Member Visibility

Module helpers/webhook-proxy

Index

Interfaces

WebhookProxyOptions +helpers/webhook-proxy | probot

Module helpers/webhook-proxy

Index

Interfaces

WebhookProxyOptions

Functions

createWebhookProxy

Settings

Member Visibility

Module index

References

ApplicationFunction +index | probot

Module index

References

ApplicationFunction ApplicationFunctionOptions Context Options diff --git a/api/13.3.7/modules/manifest_creation.html b/api/13.3.7/modules/manifest_creation.html index 67597244231..8e3ecee0e11 100644 --- a/api/13.3.7/modules/manifest_creation.html +++ b/api/13.3.7/modules/manifest_creation.html @@ -1,4 +1,4 @@ -manifest-creation | probot

Module manifest-creation

Index

Classes

ManifestCreation +manifest-creation | probot

Module manifest-creation

Index

Classes

ManifestCreation

Settings

Member Visibility

Module octokit/get-authenticated-octokit

Index

Functions

getAuthenticatedOctokit +octokit/get-authenticated-octokit | probot

Module octokit/get-authenticated-octokit

Index

Functions

getAuthenticatedOctokit

Settings

Member Visibility

Module octokit/get-octokit-throttle-options

Index

Functions

getOctokitThrottleOptions +octokit/get-octokit-throttle-options | probot

Module octokit/get-octokit-throttle-options

Index

Functions

getOctokitThrottleOptions

Settings

Member Visibility

Module octokit/get-probot-octokit-with-defaults

Index

Functions

getProbotOctokitWithDefaults +octokit/get-probot-octokit-with-defaults | probot

Module octokit/get-probot-octokit-with-defaults

Index

Functions

getProbotOctokitWithDefaults

Settings

Member Visibility

Module octokit/get-webhooks

Index

Functions

getWebhooks +octokit/get-webhooks | probot

Module octokit/get-webhooks

Index

Functions

getWebhooks

Settings

Member Visibility

Module octokit/octokit-plugin-probot-request-logging

Index

Functions

probotRequestLogging +octokit/octokit-plugin-probot-request-logging | probot

Module octokit/octokit-plugin-probot-request-logging

Index

Functions

probotRequestLogging

Settings

Member Visibility

Module octokit/octokit-webhooks-transform

Index

Functions

webhookTransform +octokit/octokit-webhooks-transform | probot

Module octokit/octokit-webhooks-transform

Index

Functions

webhookTransform

Settings

Member Visibility

Module octokit/probot-octokit

Index

Type Aliases

ProbotOctokit +octokit/probot-octokit | probot

Module octokit/probot-octokit

Index

Type Aliases

ProbotOctokit

Variables

ProbotOctokit

Settings

Member Visibility

Module probot

Index

Classes

Probot +probot | probot

Module probot

Index

Classes

Probot

Type Aliases

Constructor

Settings

Member Visibility

Module run

Index

Functions

run +run | probot

Module run

Index

Functions

run

Settings

Member Visibility

Module server/logging-middleware

Index

Functions

getLoggingMiddleware +server/logging-middleware | probot

Module server/logging-middleware

Index

Functions

getLoggingMiddleware

Settings

Member Visibility

Module server/server

Index

Classes

Server +server/server | probot

Module server/server

Index

Classes

Server

Variables

defaultWebhooksPath

Settings

Member Visibility

Module types

Index

Interfaces

Options +types | probot

Module types

Index

Interfaces

Options

Type Aliases

ApplicationFunction ApplicationFunctionOptions Env diff --git a/api/13.3.7/modules/version.html b/api/13.3.7/modules/version.html index d5dd0de6879..d66e7bf45ef 100644 --- a/api/13.3.7/modules/version.html +++ b/api/13.3.7/modules/version.html @@ -1,4 +1,4 @@ -version | probot

Module version

Index

Variables

VERSION +version | probot

Module version

Index

Variables

VERSION

Settings

Member Visibility

Module views/import

Index

Functions

importView +views/import | probot

Module views/import

Index

Functions

importView

Settings

Member Visibility

Module views/probot

Index

Functions

probotView +views/probot | probot

Module views/probot

Index

Functions

probotView

Settings

Member Visibility

Module views/setup

Index

Functions

setupView +views/setup | probot

Module views/setup

Index

Functions

setupView

Settings

Member Visibility

Module views/success

Index

Functions

successView +views/success | probot

Module views/success

Index

Functions

successView

Settings

Member Visibility

Type Alias MergeOptions

MergeOptions: merge.Options

Settings

Member Visibility

Type Alias MergeOptions

MergeOptions: merge.Options

Settings

Member Visibility
diff --git a/api/13.3.7/types/helpers_get_log.GetLogOptions.html b/api/13.3.7/types/helpers_get_log.GetLogOptions.html index d3b99b6094a..b1dce469022 100644 --- a/api/13.3.7/types/helpers_get_log.GetLogOptions.html +++ b/api/13.3.7/types/helpers_get_log.GetLogOptions.html @@ -1,4 +1,4 @@ -GetLogOptions | probot

Type Alias GetLogOptions

GetLogOptions: {
    level?: LogLevel;
    logMessageKey?: string;
} & Options

Settings

Member Visibility

Type Alias GetLogOptions

GetLogOptions: {
    level?: LogLevel;
    logMessageKey?: string;
} & Options

Settings

Member Visibility
diff --git a/api/13.3.7/types/octokit_probot_octokit.ProbotOctokit.html b/api/13.3.7/types/octokit_probot_octokit.ProbotOctokit.html index c72df76bd33..2eb2910a8a4 100644 --- a/api/13.3.7/types/octokit_probot_octokit.ProbotOctokit.html +++ b/api/13.3.7/types/octokit_probot_octokit.ProbotOctokit.html @@ -1,4 +1,4 @@ -ProbotOctokit | probot

Type Alias ProbotOctokit

ProbotOctokit: InstanceType<typeof ProbotOctokit>

Settings

Member Visibility

Type Alias ProbotOctokit

ProbotOctokit: InstanceType<typeof ProbotOctokit>

Settings

Member Visibility
diff --git a/api/13.3.7/types/probot.Constructor.html b/api/13.3.7/types/probot.Constructor.html index 7f74f17d300..a30aa28a24b 100644 --- a/api/13.3.7/types/probot.Constructor.html +++ b/api/13.3.7/types/probot.Constructor.html @@ -1,4 +1,4 @@ -Constructor | probot

Type Alias Constructor<T>

Constructor<T>: (new (...args: any[]) => T)

Type Parameters

  • T = any

Settings

Member Visibility

Type Alias Constructor<T>

Constructor<T>: (new (...args: any[]) => T)

Type Parameters

  • T = any

Settings

Member Visibility
diff --git a/api/13.3.7/types/types.ApplicationFunction.html b/api/13.3.7/types/types.ApplicationFunction.html index 9bf618f498c..d8f7580e75d 100644 --- a/api/13.3.7/types/types.ApplicationFunction.html +++ b/api/13.3.7/types/types.ApplicationFunction.html @@ -1,4 +1,4 @@ -ApplicationFunction | probot

Type Alias ApplicationFunction

ApplicationFunction: ((app: Probot, options: ApplicationFunctionOptions) => void | Promise<void>)

Settings

Member Visibility

Type Alias ApplicationFunction

ApplicationFunction: ((app: Probot, options: ApplicationFunctionOptions) => void | Promise<void>)

Settings

Member Visibility
diff --git a/api/13.3.7/types/types.ApplicationFunctionOptions.html b/api/13.3.7/types/types.ApplicationFunctionOptions.html index ba3d18e2ddb..e393a79fea7 100644 --- a/api/13.3.7/types/types.ApplicationFunctionOptions.html +++ b/api/13.3.7/types/types.ApplicationFunctionOptions.html @@ -1,4 +1,4 @@ -ApplicationFunctionOptions | probot

Type Alias ApplicationFunctionOptions

ApplicationFunctionOptions: {
    cwd?: string;
    getRouter?: ((path?: string) => express.Router);
    [key: string]: unknown;
}

Settings

Member Visibility

Type Alias ApplicationFunctionOptions

ApplicationFunctionOptions: {
    cwd?: string;
    getRouter?: ((path?: string) => express.Router);
    [key: string]: unknown;
}

Settings

Member Visibility
diff --git a/api/13.3.7/types/types.Env.html b/api/13.3.7/types/types.Env.html index 1be2e1eabe7..9306685bd1a 100644 --- a/api/13.3.7/types/types.Env.html +++ b/api/13.3.7/types/types.Env.html @@ -1,4 +1,4 @@ -Env | probot

Type Alias Env

Env: Record<Uppercase<string>, string>

Settings

Member Visibility

Type Alias Env

Env: Record<Uppercase<string>, string>

Settings

Member Visibility
diff --git a/api/13.3.7/types/types.Manifest.html b/api/13.3.7/types/types.Manifest.html index ecb6c1f81ba..216c2e4f850 100644 --- a/api/13.3.7/types/types.Manifest.html +++ b/api/13.3.7/types/types.Manifest.html @@ -10,7 +10,7 @@
  • Optionalsetup_on_update?: boolean

    Set to true to redirect users to the setup_url after they update your GitHub App installation.

  • Optionalsetup_url?: string

    A full URL to redirect users to after they install your GitHub App if additional setup is required.

  • url: string

    Required. The homepage of your GitHub App.

    -

    • Settings

    Member Visibility
    diff --git a/api/13.3.7/types/types.MiddlewareOptions.html b/api/13.3.7/types/types.MiddlewareOptions.html index be506ec6ab7..b6668e58821 100644 --- a/api/13.3.7/types/types.MiddlewareOptions.html +++ b/api/13.3.7/types/types.MiddlewareOptions.html @@ -1,4 +1,4 @@ -MiddlewareOptions | probot

    Type Alias MiddlewareOptions

    MiddlewareOptions: {
        probot: Probot;
        webhooksPath?: string;
        [key: string]: unknown;
    }

    Settings

    Member Visibility

    Type Alias MiddlewareOptions

    MiddlewareOptions: {
        probot: Probot;
        webhooksPath?: string;
        [key: string]: unknown;
    }

    Settings

    Member Visibility
    diff --git a/api/13.3.7/types/types.OctokitOptions.html b/api/13.3.7/types/types.OctokitOptions.html index fb3e077a6ca..3205eeea5c0 100644 --- a/api/13.3.7/types/types.OctokitOptions.html +++ b/api/13.3.7/types/types.OctokitOptions.html @@ -1,4 +1,4 @@ -OctokitOptions | probot

    Type Alias OctokitOptions

    OctokitOptions: NonNullable<ConstructorParameters<typeof ProbotOctokit>[0]>

    Settings

    Member Visibility

    Type Alias OctokitOptions

    OctokitOptions: NonNullable<ConstructorParameters<typeof ProbotOctokit>[0]>

    Settings

    Member Visibility
    diff --git a/api/13.3.7/types/types.PackageJson.html b/api/13.3.7/types/types.PackageJson.html index ad87a99cda2..fb9833f96f9 100644 --- a/api/13.3.7/types/types.PackageJson.html +++ b/api/13.3.7/types/types.PackageJson.html @@ -1,4 +1,4 @@ -PackageJson | probot

    Type Alias PackageJson

    PackageJson: {
        description?: string;
        engines?: {
            [key: string]: string;
        };
        homepage?: string;
        name?: string;
        repository?: string;
        version?: string;
    }

    Settings

    Member Visibility

    Type Alias PackageJson

    PackageJson: {
        description?: string;
        engines?: {
            [key: string]: string;
        };
        homepage?: string;
        name?: string;
        repository?: string;
        version?: string;
    }

    Settings

    Member Visibility
    diff --git a/api/13.3.7/types/types.ProbotWebhooks.html b/api/13.3.7/types/types.ProbotWebhooks.html index 86b3be9c9e9..a4a834b1c33 100644 --- a/api/13.3.7/types/types.ProbotWebhooks.html +++ b/api/13.3.7/types/types.ProbotWebhooks.html @@ -1,4 +1,4 @@ -ProbotWebhooks | probot

    Type Alias ProbotWebhooks

    ProbotWebhooks: Webhooks<SimplifiedObject>

    Settings

    Member Visibility

    Type Alias ProbotWebhooks

    ProbotWebhooks: Webhooks<SimplifiedObject>

    Settings

    Member Visibility
    diff --git a/api/13.3.7/types/types.ServerOptions.html b/api/13.3.7/types/types.ServerOptions.html index f5a13c300d3..db043cc6430 100644 --- a/api/13.3.7/types/types.ServerOptions.html +++ b/api/13.3.7/types/types.ServerOptions.html @@ -1,4 +1,4 @@ -ServerOptions | probot

    Type Alias ServerOptions

    ServerOptions: {
        Probot: typeof Probot;
        cwd?: string;
        host?: string;
        log?: Logger;
        loggingOptions?: LoggingOptions;
        port?: number;
        request?: RequestRequestOptions;
        webhookPath?: string;
        webhookProxy?: string;
    }

    Settings

    Member Visibility

    Type Alias ServerOptions

    ServerOptions: {
        Probot: typeof Probot;
        cwd?: string;
        host?: string;
        log?: Logger;
        loggingOptions?: LoggingOptions;
        port?: number;
        request?: RequestRequestOptions;
        webhookPath?: string;
        webhookProxy?: string;
    }

    Settings

    Member Visibility
    diff --git a/api/13.3.7/types/types.State.html b/api/13.3.7/types/types.State.html index fdd3e09dc89..42414392c79 100644 --- a/api/13.3.7/types/types.State.html +++ b/api/13.3.7/types/types.State.html @@ -1,4 +1,4 @@ -State | probot

    Type Alias State

    State: {
        Octokit: typeof ProbotOctokit;
        appId?: number;
        baseUrl?: string;
        cache?: LRUCache<number, string>;
        githubToken?: string;
        host?: string;
        log: Logger;
        octokit: ProbotOctokit;
        port?: number;
        privateKey?: string;
        request?: RequestRequestOptions;
        webhookPath: string;
        webhooks: {
            secret?: string;
        };
    }

    Settings

    Member Visibility

    Type Alias State

    State: {
        Octokit: typeof ProbotOctokit;
        appId?: number;
        baseUrl?: string;
        cache?: LRUCache<number, string>;
        githubToken?: string;
        host?: string;
        log: Logger;
        octokit: ProbotOctokit;
        port?: number;
        privateKey?: string;
        request?: RequestRequestOptions;
        webhookPath: string;
        webhooks: {
            secret?: string;
        };
    }

    Settings

    Member Visibility
    diff --git a/api/13.3.7/variables/octokit_probot_octokit.ProbotOctokit-1.html b/api/13.3.7/variables/octokit_probot_octokit.ProbotOctokit-1.html index 010c184002f..9785bc93feb 100644 --- a/api/13.3.7/variables/octokit_probot_octokit.ProbotOctokit-1.html +++ b/api/13.3.7/variables/octokit_probot_octokit.ProbotOctokit-1.html @@ -1,4 +1,4 @@ -ProbotOctokit | probot

    Variable ProbotOctokitConst

    ProbotOctokit: typeof Octokit & Constructor<{} & {} & RestEndpointMethods & Api & API> = ...

    Settings

    Member Visibility

    Variable ProbotOctokitConst

    ProbotOctokit: typeof Octokit & Constructor<{} & {} & RestEndpointMethods & Api & API> = ...

    Settings

    Member Visibility
    diff --git a/api/13.3.7/variables/server_server.defaultWebhooksPath.html b/api/13.3.7/variables/server_server.defaultWebhooksPath.html index 40ca7c97ff4..5d13f6d4d10 100644 --- a/api/13.3.7/variables/server_server.defaultWebhooksPath.html +++ b/api/13.3.7/variables/server_server.defaultWebhooksPath.html @@ -1,4 +1,4 @@ -defaultWebhooksPath | probot

    Variable defaultWebhooksPathConst

    defaultWebhooksPath: "/api/github/webhooks" = "/api/github/webhooks"

    Settings

    Member Visibility

    Variable defaultWebhooksPathConst

    defaultWebhooksPath: "/api/github/webhooks" = "/api/github/webhooks"

    Settings

    Member Visibility
    diff --git a/api/13.3.7/variables/version.VERSION.html b/api/13.3.7/variables/version.VERSION.html index 4eb99696165..24b876dfb68 100644 --- a/api/13.3.7/variables/version.VERSION.html +++ b/api/13.3.7/variables/version.VERSION.html @@ -1,4 +1,4 @@ -VERSION | probot

    Variable VERSIONConst

    VERSION: "0.0.0-development" = "0.0.0-development"

    Settings

    Member Visibility

    Variable VERSIONConst

    VERSION: "0.0.0-development" = "0.0.0-development"

    Settings

    Member Visibility