10 lines
7.5 KiB
HTML
Vendored
10 lines
7.5 KiB
HTML
Vendored
<!DOCTYPE html>
|
|
<html lang="en"><!-- use theme color or fallback -->
|
|
<!--use textcolor from settings, otherwise create a contrasting color to theme color-->
|
|
<head><meta charset="utf-8"/><link href="../../bootstrap/css/bootstrap.min.css" rel="stylesheet"/><link href="../../bootstrap/css/bootstrap-responsive.min.css" rel="stylesheet"/><link href="../../bootstrap/css/bootstrap-select.min.css" rel="stylesheet"/><link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700,700italic,400italic" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:200,600,600italic,400" rel="stylesheet" type="text/css"/><link href="https://netdna.bootstrapcdn.com/font-awesome/4.1.0/css/font-awesome.css" rel="stylesheet" type="text/css"/><script src="../../jquery-1.9.1.min.js"></script><script src="../../bootstrap/js/bootstrap.min.js"></script><script src="../../bootstrap/js/bootstrap-select.min.js"></script><link href="../../styles.css" rel="stylesheet"/><link href="../../extra-styles.css" rel="stylesheet"/><link href="../../haxe-nav.css" rel="stylesheet"/><link href="../../dark-mode.css" rel="stylesheet"/><script>var dox = {rootPath: "../../",platforms: ["doc"]};</script><script src="../../nav.js"></script><script src="../../index.js"></script><link rel="icon" href="../../favicon.ico" type="image/x-icon"/><title>funkin.github.GitHub</title></head><body><script>/* Here to prevent flash of unstyled content */let systemDarkMode = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches;if ((!localStorage.theme && systemDarkMode) || localStorage.theme == "dark") {document.body.style.backgroundColor = "#111";document.body.style.opacity = "0";document.addEventListener("DOMContentLoaded", function(event) {toggleTheme();document.body.style.backgroundColor = "";document.body.style.opacity = "";});}</script><style>
|
|
.navbar .brand {
|
|
display: inline-block;
|
|
float: none;
|
|
text-shadow: 0 0 0 transparent;
|
|
}
|
|
</style><nav class="nav"><div class="navbar"><div class="navbar-inner" style="background:#FAFAFA; border-bottom:1px solid rgba(0,0,0,.09)"><div class="container"><a class="brand" style="color:#000000" href="../../">API Documentation</a><a href="#" id="theme-toggle" class="brand" style="color:#000000" onclick="toggleTheme()" title="Toggle Dark Mode"><i class="fa fa-moon-o"></i></a></div></div></div></nav><div class="container main-content"><div class="row-fluid"><div class="span3"><div class="well sidebar-nav"><form class="form-search" id="searchForm"><div class="input-prepend input-block-level"><span class="add-on"><i class="fa fa-search"></i></span><input id="search" type="text" placeholder="Filter (Ctrl+P)" autocomplete="off"/></div></form></div><div class="well sidebar-nav" id="explorer"><div id="nav"></div></div></div><div class="span9"><div class="page-header"><h1><small>class</small> GitHub</h1><h4><small>package <a href="../../funkin/github/index.html">funkin.github</a></small></h4> <span class="label label-meta label-meta-build" title="Builds a class or enum from a macro.">@:build(hscript.ClassExtendMacro.build())</span></div><div class="body"><div class="doc doc-main"><p></p></div><h3 class="section">Static methods</h3><div class="fields"><div class="field "><a name="__requestBytesOnGitHubServers"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#__requestBytesOnGitHubServers"><span class="identifier">__requestBytesOnGitHubServers</span></a>(<span style="white-space:nowrap">url:<span class="type">String</span></span>):<span class="type">Bytes</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="__requestOnGitHubServers"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#__requestOnGitHubServers"><span class="identifier">__requestOnGitHubServers</span></a>(<span style="white-space:nowrap">url:<span class="type">String</span></span>):<span class="type">String</span></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="filterReleases"></a><h3 class="anchor"><code><span class="label label-meta label-meta-value" title="Used to store default values for fields and function arguments.">@:value({ keepDrafts : false, keepPrereleases : true })</span><span class="label label-static">static</span><span class="label label-inline">inline</span><a href="#filterReleases"><span class="identifier">filterReleases</span></a>(<span style="white-space:nowrap">releases:<span class="type">Array</span><<a class="type" title="funkin.github.GitHubRelease" href="../../funkin/github/GitHubRelease.html">GitHubRelease</a>>,</span> <span style="white-space:nowrap">keepPrereleases:<span class="type">Bool</span> = true,</span> <span style="white-space:nowrap">keepDrafts:<span class="type">Bool</span> = false</span>):<span class="type">Array</span><<a class="type" title="funkin.github.GitHubRelease" href="../../funkin/github/GitHubRelease.html">GitHubRelease</a>></code></h3><div class="doc"><p>Filters all releases gotten by <code>getReleases</code></p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>releases</code></th><td><p>Releases</p></td></tr><tr><th style="width:25%;"><code>keepPrereleases</code></th><td><p>Whenever to keep Pre-Releases.</p></td></tr><tr><th style="width:25%;"><code>keepDrafts</code></th><td><p>Whenever to keep Drafts.</p></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>Filtered releases.</p></div></div></div><div class="field "><a name="getContributors"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#getContributors"><span class="identifier">getContributors</span></a>(<span style="white-space:nowrap">user:<span class="type">String</span>,</span> <span style="white-space:nowrap">repository:<span class="type">String</span>,</span> <span style="white-space:nowrap">?onError:<span class="type">Exception</span> ‑> <span class="type">Void</span></span>):<span class="type">Array</span><<a class="type" title="funkin.github.GitHubContributor" href="../../funkin/github/GitHubContributor.html">GitHubContributor</a>></code></h3><div class="doc"><p></p></div></div><div class="field "><a name="getReleases"></a><h3 class="anchor"><code><span class="label label-static">static</span><a href="#getReleases"><span class="identifier">getReleases</span></a>(<span style="white-space:nowrap">user:<span class="type">String</span>,</span> <span style="white-space:nowrap">repository:<span class="type">String</span>,</span> <span style="white-space:nowrap">?onError:<span class="type">Exception</span> ‑> <span class="type">Void</span></span>):<span class="type">Array</span><<a class="type" title="funkin.github.GitHubRelease" href="../../funkin/github/GitHubRelease.html">GitHubRelease</a>></code></h3><div class="doc"><p>Gets all the releases from a specific GitHub repository using the GitHub API.</p><p class="javadoc">Parameters:</p><table class="table table-bordered params"><tr><th style="width:25%;"><code>user</code></th><td></td></tr><tr><th style="width:25%;"><code>repository</code></th><td></td></tr></table><p class="javadoc">Returns:</p><div class="indent inline-content"><p>Releases</p></div></div></div></div></div></div></div></div><footer class="section site-footer" style="background:#FAFAFA"><div class="container"><div class="copyright"><p style="color:#000000">© 2023 </p></div></div></footer><script src="../..//highlighter.js"></script><link href="../../highlighter.css" rel="stylesheet"/></body></html> |