Sign upLogin

bowtie-co/ts-github

View on GitHub
Star
docs/index.html

Summary

Maintainability
Test Coverage
<!doctype html>
<html class="default no-js">
<head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <title>@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">
            </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>@bowtie/ts-github</h1>
            <div class="tsd-panel tsd-typography">
                <a href="#ts-github" id="ts-github" style="color: inherit; text-decoration: none;">
                    <h1>ts-github</h1>
                </a>
                <p>TypeScript Adapter for Github (octokit)</p>
            </div>
            <!--{&quot;options&quot;:&quot;/Users/charlie/Documents/bowtie/agency/ts-github&quot;,&quot;tsconfig&quot;:&quot;/Users/charlie/Documents/bowtie/agency/ts-github&quot;,&quot;inputFiles&quot;:[&quot;src&quot;],&quot;mode&quot;:0,&quot;includeDeclarations&quot;:false,&quot;entryPoint&quot;:&quot;&quot;,&quot;exclude&quot;:[],&quot;externalPattern&quot;:[],&quot;excludeExternals&quot;:true,&quot;excludeNotExported&quot;:true,&quot;excludeNotDocumented&quot;:false,&quot;excludePrivate&quot;:false,&quot;excludeProtected&quot;:false,&quot;ignoreCompilerErrors&quot;:false,&quot;disableSources&quot;:false,&quot;includes&quot;:&quot;&quot;,&quot;media&quot;:&quot;&quot;,&quot;out&quot;:&quot;docs&quot;,&quot;json&quot;:&quot;&quot;,&quot;theme&quot;:&quot;./node_modules/typedoc-neo-theme/bin/default&quot;,&quot;name&quot;:&quot;&quot;,&quot;includeVersion&quot;:false,&quot;excludeTags&quot;:[],&quot;readme&quot;:&quot;&quot;,&quot;defaultCategory&quot;:&quot;Other&quot;,&quot;categoryOrder&quot;:[],&quot;categorizeByGroup&quot;:true,&quot;gitRevision&quot;:&quot;&quot;,&quot;gitRemote&quot;:&quot;origin&quot;,&quot;gaID&quot;:&quot;&quot;,&quot;gaSite&quot;:&quot;auto&quot;,&quot;hideGenerator&quot;:false,&quot;toc&quot;:[],&quot;disableOutputCheck&quot;:false,&quot;help&quot;:false,&quot;version&quot;:false,&quot;plugin&quot;:[&quot;typedoc-neo-theme&quot;],&quot;logger&quot;:&quot;console&quot;,&quot;listInvalidSymbolLinks&quot;: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="interfaces/igithubbranch.html" class="tsd-kind-icon">IGithub<wbr>Branch</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubbranchprotection.html" class="tsd-kind-icon">IGithub<wbr>Branch<wbr>Protection</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubclient.html" class="tsd-kind-icon">IGithub<wbr>Client</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubcommit.html" class="tsd-kind-icon">IGithub<wbr>Commit</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubcommitresponse.html" class="tsd-kind-icon">IGithub<wbr>Commit<wbr>Response</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubcommitstatus.html" class="tsd-kind-icon">IGithub<wbr>Commit<wbr>Status</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubcommitstatussummary.html" class="tsd-kind-icon">IGithub<wbr>Commit<wbr>Status<wbr>Summary</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubcontents.html" class="tsd-kind-icon">IGithub<wbr>Contents</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubcontentscommitparams.html" class="tsd-kind-icon">IGithub<wbr>Contents<wbr>Commit<wbr>Params</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/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="interfaces/igithubdeletefileparams.html" class="tsd-kind-icon">IGithub<wbr>Delete<wbr>File<wbr>Params</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubissue.html" class="tsd-kind-icon">IGithub<wbr>Issue</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithublabel.html" class="tsd-kind-icon">IGithub<wbr>Label</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithublink.html" class="tsd-kind-icon">IGithub<wbr>Link</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithublinks.html" class="tsd-kind-icon">IGithub<wbr>Links</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubmilestone.html" class="tsd-kind-icon">IGithub<wbr>Milestone</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithuborg.html" class="tsd-kind-icon">IGithub<wbr>Org</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithuborgparams.html" class="tsd-kind-icon">IGithub<wbr>Org<wbr>Params</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubparams.html" class="tsd-kind-icon">IGithub<wbr>Params</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubprops.html" class="tsd-kind-icon">IGithub<wbr>Props</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubpull.html" class="tsd-kind-icon">IGithub<wbr>Pull</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubrepo.html" class="tsd-kind-icon">IGithub<wbr>Repo</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubrepobranchparams.html" class="tsd-kind-icon">IGithub<wbr>Repo<wbr>Branch<wbr>Params</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubrepocontentsparams.html" class="tsd-kind-icon">IGithub<wbr>Repo<wbr>Contents<wbr>Params</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubrepofilterparams.html" class="tsd-kind-icon">IGithub<wbr>Repo<wbr>Filter<wbr>Params</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubrepoissueparams.html" class="tsd-kind-icon">IGithub<wbr>Repo<wbr>Issue<wbr>Params</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubrepoparams.html" class="tsd-kind-icon">IGithub<wbr>Repo<wbr>Params</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubrepopullparams.html" class="tsd-kind-icon">IGithub<wbr>Repo<wbr>Pull<wbr>Params</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubreporefparams.html" class="tsd-kind-icon">IGithub<wbr>Repo<wbr>Ref<wbr>Params</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/igithubstatussummaryparams.html" class="tsd-kind-icon">IGithub<wbr>Status<wbr>Summary<wbr>Params</a>
                    </li>
                    <li class=" tsd-kind-interface root">
                        <a href="interfaces/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>