Codename LogoCodename Logo

funkin.backend.system.github.GitHub

APIWiki

Static methods

View in GitHub

@:value({ keepDrafts : false, keepPrereleases : true })staticinlinefilterReleases(releases:Array<GitHubRelease>, keepPrereleases:Bool = true, keepDrafts:Bool = false):Array<GitHubRelease>

Filters all releases gotten by getReleases

Parameters:

releases

Releases

keepPrereleases

Whenever to keep Pre-Releases.

keepDrafts

Whenever to keep Drafts.

Returns:

Filtered releases.

View in GitHub

staticgetContributors(user:String, repository:String, ?onError:Exception ‑> Void):Array<GitHubContributor>

Gets the contributors list from a specific GitHub repository using the GitHub API.

Parameters:

user

The user/organization that owns the repository

repository

The repository name

onError

Error Callback

Returns:

Contributors List

View in GitHub

staticgetOrganization(org:String, ?onError:Exception ‑> Void):GitHubOrganization

Gets a specific GitHub organization using the GitHub API.

Parameters:

org

The organization to get

onError

Error Callback

Returns:

Organization

View in GitHub

staticgetOrganizationMembers(org:String, ?onError:Exception ‑> Void):Array<GitHubContributor>

Gets the members list from a specific GitHub organization using the GitHub API. NOTE: Members use Contributors' structure!

Parameters:

org

The organization to get the members from

onError

Error Callback

Returns:

Members List

View in GitHub

staticgetReleases(user:String, repository:String, ?onError:Exception ‑> Void):Array<GitHubRelease>

Gets all the releases from a specific GitHub repository using the GitHub API.

Parameters:

user

The user/organization that owns the repository

repository

The repository name

onError

Error Callback

Returns:

Releases

View in GitHub

staticgetUser(user:String, ?onError:Exception ‑> Void):GitHubUser

Gets a specific GitHub user/organization using the GitHub API. NOTE: If organization, it will be returned with the structure of a normal user; use getOrganization if you specifically want an organization!

Parameters:

user

The user/organization to get

onError

Error Callback

Returns:

User/Organization