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

1.8 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
resolveProject(options) TODO
syncIssueLabels(options) goes through and resolves each issue in the project. if there are changes and no errors, then updates the issue.
syncProjectLabels(options) TODO

Interfaces

Interface Description
ChangeSet A set of labels to add and/or remove.
Remote Basic functions which every remote API must provide.
RemoteOptions Options for a new remote instance.
ResolveInput Collected inputs for a resolver run.
ResolveResult Collected results from a resolver run.
StateLabel Grouped labels: the equivalent of a radio group.
StateValue One of many values for a particular state.
SyncOptions TODO

Type Aliases

Type Alias Description
FlagLabel Individual labels: the equivalent of a checkbox.