mirror of
https://github.com/tiktok/sparo.git
synced 2024-11-23 15:48:16 -05:00
121 lines
3.4 KiB
Markdown
121 lines
3.4 KiB
Markdown
## API Report File for "sparo-lib"
|
|
|
|
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
|
|
|
|
```ts
|
|
|
|
/// <reference types="node" />
|
|
|
|
import * as child_process from 'child_process';
|
|
import { GitRepoInfo } from 'git-repo-info';
|
|
import { ITerminal } from '@rushstack/terminal';
|
|
|
|
// Warning: (ae-forgotten-export) The symbol "Constructable" needs to be exported by the entry point index.d.ts
|
|
//
|
|
// @alpha
|
|
export function getFromContainerAsync<T>(clazz: Constructable<T>): Promise<T>;
|
|
|
|
// @alpha
|
|
export class GitService {
|
|
// (undocumented)
|
|
executeGitCommand({ args, workingDirectory }: IExecuteGitCommandParams): child_process.SpawnSyncReturns<string>;
|
|
// (undocumented)
|
|
executeGitCommandAndCaptureOutput({ args, workingDirectory }: IExecuteGitCommandParams): string;
|
|
getBasenameFromUrl(url: string): string;
|
|
// (undocumented)
|
|
getBranchRemote(branch: string): string;
|
|
// (undocumented)
|
|
getGitConfig(k: string, option?: {
|
|
dryRun?: boolean;
|
|
global?: boolean;
|
|
}): string | undefined;
|
|
// (undocumented)
|
|
getGitEmail(): string | undefined;
|
|
// (undocumented)
|
|
getGitPathOrThrow(): string;
|
|
// (undocumented)
|
|
getGitUser(): string | undefined;
|
|
// (undocumented)
|
|
getGitVersion(): [number, number, number] | undefined;
|
|
// (undocumented)
|
|
getIsSparseCheckoutMode(): boolean | undefined;
|
|
// (undocumented)
|
|
getRepoInfo(): GitRepoInfo;
|
|
get gitPath(): string | undefined;
|
|
// (undocumented)
|
|
hasFile(filename: string, branch: string): boolean;
|
|
// (undocumented)
|
|
setGitConfig(k: string, v: string | number | boolean, option?: {
|
|
dryRun?: boolean;
|
|
global?: boolean;
|
|
}): void;
|
|
// (undocumented)
|
|
setRecommendConfig(option?: {
|
|
overwrite?: boolean;
|
|
dryRun?: boolean;
|
|
}): void;
|
|
}
|
|
|
|
// @alpha
|
|
export interface ICallerPackageJson {
|
|
name: string;
|
|
version: string;
|
|
}
|
|
|
|
// @alpha (undocumented)
|
|
export type ICollectTelemetryFunction = (data: ITelemetryData) => Promise<void>;
|
|
|
|
// @alpha (undocumented)
|
|
export interface IExecuteGitCommandParams {
|
|
// (undocumented)
|
|
args: string[];
|
|
// (undocumented)
|
|
workingDirectory?: string;
|
|
}
|
|
|
|
// @public
|
|
export interface ILaunchOptions {
|
|
// @internal
|
|
callerPackageJson?: ICallerPackageJson;
|
|
// @internal
|
|
collectTelemetryAsync?: ICollectTelemetryFunction;
|
|
}
|
|
|
|
// @alpha (undocumented)
|
|
export interface ITelemetryData {
|
|
readonly args: string[];
|
|
readonly commandName: string;
|
|
readonly durationInSeconds: number;
|
|
readonly endTimestampMs?: number;
|
|
readonly isRawGitCommand?: boolean;
|
|
readonly startTimestampMs?: number;
|
|
}
|
|
|
|
export { ITerminal }
|
|
|
|
// @public
|
|
export class Sparo {
|
|
// (undocumented)
|
|
static launchSparoAsync(launchOptions: ILaunchOptions): Promise<void>;
|
|
// (undocumented)
|
|
static launchSparoCIAsync(launchOptions: ILaunchOptions): Promise<void>;
|
|
}
|
|
|
|
// @alpha
|
|
export class TerminalService {
|
|
constructor();
|
|
// (undocumented)
|
|
setIsDebug(value: boolean): void;
|
|
// (undocumented)
|
|
setIsVerbose(value: boolean): void;
|
|
// (undocumented)
|
|
get terminal(): ITerminal;
|
|
// (undocumented)
|
|
writeTaskFooter(): void;
|
|
// (undocumented)
|
|
writeTaskHeader(taskTitle: string): void;
|
|
}
|
|
|
|
// (No @packageDocumentation comment for this package)
|
|
|
|
```
|