cautious-journey/docs/api/cautious-journey.md

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [cautious-journey](./cautious-journey.md)

## cautious-journey package

## Classes

|  Class | Description |
|  --- | --- |
|  [GithubRemote](./cautious-journey.githubremote.md) | Github/Octokit API implementation of the <code>Remote</code> contract. |
|  [GitlabRemote](./cautious-journey.gitlabremote.md) | Gitlab API implementation of the <code>Remote</code> contract. |

## Functions

|  Function | Description |
|  --- | --- |
|  [resolveLabels(options)](./cautious-journey.resolvelabels.md) | Resolve the desired set of labels, given a starting set and the flags/states to be applied. |
|  [syncIssueLabels(options)](./cautious-journey.syncissuelabels.md) | goes through and resolves each issue in the project. if there are changes and no errors, then updates the issue. |
|  [syncProjectLabels(options)](./cautious-journey.syncprojectlabels.md) |  |

## Interfaces

|  Interface | Description |
|  --- | --- |
|  [ChangeSet](./cautious-journey.changeset.md) | A set of labels to add and/or remove. |
|  [Remote](./cautious-journey.remote.md) | Basic functions which every remote API must provide. |
|  [RemoteOptions](./cautious-journey.remoteoptions.md) |  |
|  [ResolveInput](./cautious-journey.resolveinput.md) | Collected inputs for a resolver run. |
|  [ResolveResult](./cautious-journey.resolveresult.md) | Collected results from a resolver run. |
|  [StateLabel](./cautious-journey.statelabel.md) | Grouped labels: the equivalent of a radio group. |
|  [StateValue](./cautious-journey.statevalue.md) | One of many values for a particular state. |
|  [SyncOptions](./cautious-journey.syncoptions.md) |  |

## Type Aliases

|  Type Alias | Description |
|  --- | --- |
|  [FlagLabel](./cautious-journey.flaglabel.md) | Individual labels: the equivalent of a checkbox. |
feat: sketch out config, label interfaces 2020-08-12 00:14:42 +00:00			`<!-- Do not edit this file. It is automatically generated by API Documenter. -->`

			`[Home](./index.md) > [cautious-journey](./cautious-journey.md)`

			`## cautious-journey package`

feat: add issue, label sync stubs, remote options to config, flatten resolver inputs 2020-08-12 01:39:53 +00:00			`## Classes`

			`\| Class \| Description \|`
			`\| --- \| --- \|`
			`\| [GithubRemote](./cautious-journey.githubremote.md) \| Github/Octokit API implementation of the <code>Remote</code> contract. \|`
			`\| [GitlabRemote](./cautious-journey.gitlabremote.md) \| Gitlab API implementation of the <code>Remote</code> contract. \|`

feat: sketch out config, label interfaces 2020-08-12 00:14:42 +00:00			`## Functions`

			`\| Function \| Description \|`
			`\| --- \| --- \|`
stub more docs, check for errors in issue sync, sort labels by priority and name 2020-08-15 14:31:28 +00:00			`\| [resolveLabels(options)](./cautious-journey.resolvelabels.md) \| Resolve the desired set of labels, given a starting set and the flags/states to be applied. \|`
lint: rename project-level sync, fix imports 2020-08-15 21:41:48 +00:00			`\| [syncIssueLabels(options)](./cautious-journey.syncissuelabels.md) \| goes through and resolves each issue in the project. if there are changes and no errors, then updates the issue. \|`
			`\| [syncProjectLabels(options)](./cautious-journey.syncprojectlabels.md) \| \|`
feat: add issue, label sync stubs, remote options to config, flatten resolver inputs 2020-08-12 01:39:53 +00:00
			`## Interfaces`

			`\| Interface \| Description \|`
			`\| --- \| --- \|`
feat(config): validate using json schema, compare issue labels for update 2020-08-15 23:50:39 +00:00			`\| [ChangeSet](./cautious-journey.changeset.md) \| A set of labels to add and/or remove. \|`
feat: add issue, label sync stubs, remote options to config, flatten resolver inputs 2020-08-12 01:39:53 +00:00			`\| [Remote](./cautious-journey.remote.md) \| Basic functions which every remote API must provide. \|`
			`\| [RemoteOptions](./cautious-journey.remoteoptions.md) \| \|`
feat: add main function, arg parsing for CLI 2020-08-12 03:19:01 +00:00			`\| [ResolveInput](./cautious-journey.resolveinput.md) \| Collected inputs for a resolver run. \|`
			`\| [ResolveResult](./cautious-journey.resolveresult.md) \| Collected results from a resolver run. \|`
feat: add issue, label sync stubs, remote options to config, flatten resolver inputs 2020-08-12 01:39:53 +00:00			`\| [StateLabel](./cautious-journey.statelabel.md) \| Grouped labels: the equivalent of a radio group. \|`
feat: add main function, arg parsing for CLI 2020-08-12 03:19:01 +00:00			`\| [StateValue](./cautious-journey.statevalue.md) \| One of many values for a particular state. \|`
			`\| [SyncOptions](./cautious-journey.syncoptions.md) \| \|`
feat: sketch out config, label interfaces 2020-08-12 00:14:42 +00:00
fix(resolve): moves labels rule check to broader scope 2020-08-15 22:24:16 +00:00			`## Type Aliases`

			`\| Type Alias \| Description \|`
			`\| --- \| --- \|`
			`\| [FlagLabel](./cautious-journey.flaglabel.md) \| Individual labels: the equivalent of a checkbox. \|`