1
0
Fork 0
cautious-journey/docs/api/cautious-journey.md

1.7 KiB

Home > cautious-journey

cautious-journey package

Classes

Class Description
GithubRemote Github/Octokit API implementation of the Remote contract.
GitlabRemote Gitlab API implementation of the Remote contract.

Functions

Function Description
resolveLabels(options) Resolve the desired set of labels, given a starting set and the flags/states to be applied.
syncIssues(options)
syncLabels(options)

Interfaces

Interface Description
FlagLabel Individual labels: the equivalent of a checkbox.
Remote Basic functions which every remote API must provide.
RemoteOptions
ResolveInput Collected inputs for a resolver run.
ResolveResult Collected results from a resolver run.
StateChange The transition between two state values.
StateLabel Grouped labels: the equivalent of a radio group.
StateValue One of many values for a particular state.
SyncOptions