GithubSearchHit class

Constructors

GithubSearchHit({String? cloneUrl, String? defaultBranch, String? description, String? fullName, String? htmlUrl, String? language, bool? private, int? stars})

Returns a new GithubSearchHit instance.

Properties

cloneUrl ↔ String?

CloneURL is the repository's https git remote.

getter/setter pair

defaultBranch ↔ String?

DefaultBranch is the branch a clone checks out.

getter/setter pair

description ↔ String?

Description is the blurb the repository's owner wrote. Empty when it has none.

getter/setter pair

fullName ↔ String?

FullName is the repository's "owner/repo" on GitHub. Finding it here does NOT make it forkable: githubFork takes a repo the org's installation was granted, and a hit from the public index usually is not one.

getter/setter pair

hashCode → int

The hash code for this object.

no setter, override

htmlUrl ↔ String?

HTMLURL is the repository's page on github.com.

getter/setter pair

language ↔ String?

Language is the primary language GitHub detected from the file mix ("Go", "TypeScript"). Empty when GitHub attributes none.

getter/setter pair

private ↔ bool?

Private is GitHub's visibility flag, passed through. This op reads the public index — the org's token only charges the rate limit to the installation — so it is false for everything a search can reach.

getter/setter pair

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

stars ↔ int?

Stars is GitHub's stargazers_count as the SEARCH INDEX held it when the query ran — a snapshot, not a live count off the repository.

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

override

Operators

operator ==(Object other) → bool

The equality operator.

override

Static Methods

fromJson(dynamic value) → GithubSearchHit?

Returns a new GithubSearchHit instance and imports its values from value if it's a Map, null otherwise.

listFromJson(dynamic json, {bool growable = false}) → List<GithubSearchHit>

mapFromJson(dynamic json) → Map<String, GithubSearchHit>

mapListFromJson(dynamic json, {bool growable = false}) → Map<String, List<GithubSearchHit>>

Constants

requiredKeys → const Set<String>

The list of required keys that must be present in a JSON.