ssube/cautious-journey

View on GitHub
docs/cautious-journey.api.md

Summary

Maintainability
Test Coverage
## API Report File for "cautious-journey"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

/// <reference types="node" />

import { BaseOptions } from 'noicejs';
import { Gitlab } from '@gitbeaker/core';
import { Logger } from 'noicejs';
import { Octokit } from '@octokit/rest';

// @public
export interface ChangeSet {
    // Warning: (ae-forgotten-export) The symbol "LabelRef" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    adds: Array<LabelRef>;
    // (undocumented)
    removes: Array<LabelRef>;
}

// Warning: (ae-forgotten-export) The symbol "BaseLabel" needs to be exported by the entry point index.d.ts
//
// @public
export type FlagLabel = BaseLabel;

// Warning: (ae-forgotten-export) The symbol "BaseRemote" needs to be exported by the entry point index.d.ts
//
// @public
export class GithubRemote extends BaseRemote<Octokit, RemoteOptions> implements Remote {
    constructor(options: RemoteOptions);
    // (undocumented)
    connect(): Promise<boolean>;
    // Warning: (ae-forgotten-export) The symbol "CommentUpdate" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    createComment(options: CommentUpdate): Promise<CommentUpdate>;
    // Warning: (ae-forgotten-export) The symbol "LabelUpdate" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    createLabel(options: LabelUpdate): Promise<LabelUpdate>;
    // Warning: (ae-forgotten-export) The symbol "LabelQuery" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    deleteLabel(options: LabelQuery): Promise<LabelQuery>;
    // (undocumented)
    labelName(label: string | {
        name?: string;
    }): string;
    // Warning: (ae-forgotten-export) The symbol "ProjectQuery" needs to be exported by the entry point index.d.ts
    // Warning: (ae-forgotten-export) The symbol "IssueUpdate" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    listIssues(options: ProjectQuery): Promise<Array<IssueUpdate>>;
    // (undocumented)
    listLabels(options: ProjectQuery): Promise<Array<LabelUpdate>>;
    // (undocumented)
    resolvePath(project: string): Promise<{
        owner: string;
        repo: string;
    }>;
    // (undocumented)
    updateIssue(options: IssueUpdate): Promise<IssueUpdate>;
    // (undocumented)
    updateLabel(options: LabelUpdate): Promise<LabelUpdate>;
}

// @public
export class GitlabRemote extends BaseRemote<Gitlab, RemoteOptions> implements Remote {
    constructor(options: RemoteOptions);
    // (undocumented)
    connect(): Promise<boolean>;
    // (undocumented)
    createComment(options: CommentUpdate): Promise<CommentUpdate>;
    // (undocumented)
    createLabel(options: LabelUpdate): Promise<LabelUpdate>;
    // (undocumented)
    deleteLabel(options: LabelUpdate): Promise<LabelUpdate>;
    // (undocumented)
    listIssues(options: ProjectQuery): Promise<Array<IssueUpdate>>;
    // (undocumented)
    listLabels(options: ProjectQuery): Promise<Array<LabelUpdate>>;
    // (undocumented)
    resolvePath(path: string): Promise<{
        groupId: number;
        projectId: number;
    }>;
    // (undocumented)
    updateIssue(options: IssueUpdate): Promise<IssueUpdate>;
    // (undocumented)
    updateLabel(options: LabelUpdate): Promise<LabelUpdate>;
}

// @public
export interface Remote {
    // (undocumented)
    connect(): Promise<boolean>;
    createComment(options: CommentUpdate): Promise<CommentUpdate>;
    createLabel(options: LabelUpdate): Promise<LabelUpdate>;
    deleteLabel(options: LabelQuery): Promise<LabelQuery>;
    listIssues(options: ProjectQuery): Promise<Array<IssueUpdate>>;
    listLabels(options: ProjectQuery): Promise<Array<LabelUpdate>>;
    updateIssue(options: IssueUpdate): Promise<IssueUpdate>;
    updateLabel(options: LabelUpdate): Promise<LabelUpdate>;
}

// @public
export interface RemoteOptions extends BaseOptions {
    data: Record<string, string>;
    dryrun: boolean;
    // (undocumented)
    logger: Logger;
    type: string;
}

// @public
export interface ResolveInput {
    // (undocumented)
    flags: Array<FlagLabel>;
    // (undocumented)
    initial: Array<string>;
    // (undocumented)
    labels: Array<string>;
    // (undocumented)
    states: Array<StateLabel>;
}

// @public
export function resolveProject(options: ResolveInput): ResolveResult;

// @public
export interface ResolveResult {
    // Warning: (ae-forgotten-export) The symbol "ChangeRecord" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    changes: Array<ChangeRecord>;
    // Warning: (ae-forgotten-export) The symbol "ErrorRecord" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    errors: Array<ErrorRecord>;
    // (undocumented)
    labels: Array<string>;
}

// @public
export interface StateLabel extends BaseLabel {
    // (undocumented)
    divider: string;
    values: Array<StateValue>;
}

// @public
export interface StateValue extends BaseLabel {
    // Warning: (ae-forgotten-export) The symbol "StateChange" needs to be exported by the entry point index.d.ts
    becomes: Array<StateChange>;
}

// @public
export function syncIssueLabels(options: SyncOptions): Promise<unknown>;

// @public
export interface SyncOptions {
    // (undocumented)
    logger: Logger;
    // Warning: (ae-forgotten-export) The symbol "ProjectConfig" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    project: ProjectConfig;
    // Warning: (ae-forgotten-export) The symbol "RandomGenerator" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    random: RandomGenerator;
    // (undocumented)
    remote: Remote;
}

// @public
export function syncProjectLabels(options: SyncOptions): Promise<unknown>;

// (No @packageDocumentation comment for this package)

```