docs/interfaces/igithubcommit.html
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>IGithubCommit | @bowtie/ts-github</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<ul class="results-priority" style="display:none">
</ul>
<a href="../index.html" class="title">@bowtie/ts-github</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="igithubcommit.html">IGithubCommit</a>
</li>
</ul>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-3 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html" style="display:none"><em>Globals</em></a>
</li>
</ul>
</nav>
</div>
<div class="col-7 offset-3 col-content">
<h1>Interface IGithubCommit</h1>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">IGithubCommit</span>
<ul class="tsd-hierarchy">
<li>
<a href="igithubcontents.html" class="tsd-signature-type">IGithubContents</a>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="igithubcommit.html#label" class="tsd-kind-icon">label</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="igithubcommit.html#ref" class="tsd-kind-icon">ref</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="igithubcommit.html#repo" class="tsd-kind-icon">repo</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="igithubcommit.html#sha" class="tsd-kind-icon">sha</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="igithubcommit.html#url" class="tsd-kind-icon">url</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="igithubcommit.html#user" class="tsd-kind-icon">user</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="label" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> label</h3>
<div class="tsd-signature tsd-kind-icon">label<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Github/Commit.ts:7</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="ref" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> ref</h3>
<div class="tsd-signature tsd-kind-icon">ref<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Github/Commit.ts:5</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="repo" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> repo</h3>
<div class="tsd-signature tsd-kind-icon">repo<span class="tsd-signature-symbol">:</span> <a href="igithubrepo.html" class="tsd-signature-type">IGithubRepo</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Github/Commit.ts:9</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="sha" class="tsd-anchor"></a>
<h3>sha</h3>
<div class="tsd-signature tsd-kind-icon">sha<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Github/Commit.ts:4</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="url" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> url</h3>
<div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Github/Commit.ts:6</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="user" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> user</h3>
<div class="tsd-signature tsd-kind-icon">user<span class="tsd-signature-symbol">:</span> <a href="igithubuser.html" class="tsd-signature-type">IGithubUser</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in Github/Commit.ts:8</li>
</ul>
</aside>
</section>
</section>
<!--{"options":"/Users/charlie/Documents/bowtie/agency/ts-github","tsconfig":"/Users/charlie/Documents/bowtie/agency/ts-github","inputFiles":["src"],"mode":0,"includeDeclarations":false,"entryPoint":"","exclude":[],"externalPattern":[],"excludeExternals":true,"excludeNotExported":true,"excludeNotDocumented":false,"excludePrivate":false,"excludeProtected":false,"ignoreCompilerErrors":false,"disableSources":false,"includes":"","media":"","out":"docs","json":"","theme":"./node_modules/typedoc-neo-theme/bin/default","name":"","includeVersion":false,"excludeTags":[],"readme":"","defaultCategory":"Other","categoryOrder":[],"categorizeByGroup":true,"gitRevision":"","gitRemote":"origin","gaID":"","gaSite":"auto","hideGenerator":false,"toc":[],"disableOutputCheck":false,"help":false,"version":false,"plugin":["typedoc-neo-theme"],"logger":"console","listInvalidSymbolLinks":false}-->
</div>
<div class="col-2 col-menu secondary-menu">
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum root">
<a href="../enums/githubcommitstatus.html" class="tsd-kind-icon">Github<wbr>Commit<wbr>Status</a>
</li>
<li class=" tsd-kind-enum root">
<a href="../enums/githubcommitstatusgroup.html" class="tsd-kind-icon">Github<wbr>Commit<wbr>Status<wbr>Group</a>
</li>
<li class=" tsd-kind-enum root">
<a href="../enums/githubfilterdirection.html" class="tsd-kind-icon">Github<wbr>Filter<wbr>Direction</a>
</li>
<li class=" tsd-kind-enum root">
<a href="../enums/githubfiltersort.html" class="tsd-kind-icon">Github<wbr>Filter<wbr>Sort</a>
</li>
<li class=" tsd-kind-enum root">
<a href="../enums/githubrepotype.html" class="tsd-kind-icon">Github<wbr>Repo<wbr>Type</a>
</li>
<li class=" tsd-kind-enum root">
<a href="../enums/githubrepovisibility.html" class="tsd-kind-icon">Github<wbr>Repo<wbr>Visibility</a>
</li>
<li class=" tsd-kind-class root">
<a href="../classes/githubclient.html" class="tsd-kind-icon">Github<wbr>Client</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubbranch.html" class="tsd-kind-icon">IGithub<wbr>Branch</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubbranchprotection.html" class="tsd-kind-icon">IGithub<wbr>Branch<wbr>Protection</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubclient.html" class="tsd-kind-icon">IGithub<wbr>Client</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-interface root">
<a href="igithubcommit.html" class="tsd-kind-icon">IGithub<wbr>Commit</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="igithubcommit.html#label" class="tsd-kind-icon">label</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="igithubcommit.html#ref" class="tsd-kind-icon">ref</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="igithubcommit.html#repo" class="tsd-kind-icon">repo</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="igithubcommit.html#sha" class="tsd-kind-icon">sha</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="igithubcommit.html#url" class="tsd-kind-icon">url</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="igithubcommit.html#user" class="tsd-kind-icon">user</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-interface root">
<a href="igithubcommitresponse.html" class="tsd-kind-icon">IGithub<wbr>Commit<wbr>Response</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubcommitstatus.html" class="tsd-kind-icon">IGithub<wbr>Commit<wbr>Status</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubcommitstatussummary.html" class="tsd-kind-icon">IGithub<wbr>Commit<wbr>Status<wbr>Summary</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubcontents.html" class="tsd-kind-icon">IGithub<wbr>Contents</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubcontentscommitparams.html" class="tsd-kind-icon">IGithub<wbr>Contents<wbr>Commit<wbr>Params</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubcreateorupdatefileparams.html" class="tsd-kind-icon">IGithub<wbr>Create<wbr>OrUpdate<wbr>File<wbr>Params</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubdeletefileparams.html" class="tsd-kind-icon">IGithub<wbr>Delete<wbr>File<wbr>Params</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubissue.html" class="tsd-kind-icon">IGithub<wbr>Issue</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithublabel.html" class="tsd-kind-icon">IGithub<wbr>Label</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithublink.html" class="tsd-kind-icon">IGithub<wbr>Link</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithublinks.html" class="tsd-kind-icon">IGithub<wbr>Links</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubmilestone.html" class="tsd-kind-icon">IGithub<wbr>Milestone</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithuborg.html" class="tsd-kind-icon">IGithub<wbr>Org</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithuborgparams.html" class="tsd-kind-icon">IGithub<wbr>Org<wbr>Params</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubparams.html" class="tsd-kind-icon">IGithub<wbr>Params</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubprops.html" class="tsd-kind-icon">IGithub<wbr>Props</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubpull.html" class="tsd-kind-icon">IGithub<wbr>Pull</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubrepo.html" class="tsd-kind-icon">IGithub<wbr>Repo</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubrepobranchparams.html" class="tsd-kind-icon">IGithub<wbr>Repo<wbr>Branch<wbr>Params</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubrepocontentsparams.html" class="tsd-kind-icon">IGithub<wbr>Repo<wbr>Contents<wbr>Params</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubrepofilterparams.html" class="tsd-kind-icon">IGithub<wbr>Repo<wbr>Filter<wbr>Params</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubrepoissueparams.html" class="tsd-kind-icon">IGithub<wbr>Repo<wbr>Issue<wbr>Params</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubrepoparams.html" class="tsd-kind-icon">IGithub<wbr>Repo<wbr>Params</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubrepopullparams.html" class="tsd-kind-icon">IGithub<wbr>Repo<wbr>Pull<wbr>Params</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubreporefparams.html" class="tsd-kind-icon">IGithub<wbr>Repo<wbr>Ref<wbr>Params</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubstatussummaryparams.html" class="tsd-kind-icon">IGithub<wbr>Status<wbr>Summary<wbr>Params</a>
</li>
<li class=" tsd-kind-interface root">
<a href="igithubuser.html" class="tsd-kind-icon">IGithub<wbr>User</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>