Website Structure

This commit is contained in:
supalerk-ar66 2026-01-13 10:46:40 +07:00
parent 62812f2090
commit 71f0676a62
22365 changed files with 4265753 additions and 791 deletions

View file

@ -0,0 +1,15 @@
import { GitError } from './git-error';
import { SimpleGitOptions } from '../types';
/**
* The `GitConstructError` is thrown when an error occurs in the constructor
* of the `simple-git` instance itself. Most commonly as a result of using
* a `baseDir` option that points to a folder that either does not exist,
* or cannot be read by the user the node script is running as.
*
* Check the `.message` property for more detail including the properties
* passed to the constructor.
*/
export declare class GitConstructError extends GitError {
readonly config: SimpleGitOptions;
constructor(config: SimpleGitOptions, message: string);
}

View file

@ -0,0 +1,30 @@
import type { SimpleGitTask } from '../types';
/**
* The `GitError` is thrown when the underlying `git` process throws a
* fatal exception (eg an `ENOENT` exception when attempting to use a
* non-writable directory as the root for your repo), and acts as the
* base class for more specific errors thrown by the parsing of the
* git response or errors in the configuration of the task about to
* be run.
*
* When an exception is thrown, pending tasks in the same instance will
* not be executed. The recommended way to run a series of tasks that
* can independently fail without needing to prevent future tasks from
* running is to catch them individually:
*
* ```typescript
import { gitP, SimpleGit, GitError, PullResult } from 'simple-git';
function catchTask (e: GitError) {
return e.
}
const git = gitP(repoWorkingDir);
const pulled: PullResult | GitError = await git.pull().catch(catchTask);
const pushed: string | GitError = await git.pushTags().catch(catchTask);
```
*/
export declare class GitError extends Error {
task?: SimpleGitTask<any> | undefined;
constructor(task?: SimpleGitTask<any> | undefined, message?: string);
}

View file

@ -0,0 +1,7 @@
import { SimpleGitOptions, SimpleGitTask } from '../types';
import { GitError } from './git-error';
export declare class GitPluginError extends GitError {
task?: SimpleGitTask<any> | undefined;
readonly plugin?: keyof SimpleGitOptions | undefined;
constructor(task?: SimpleGitTask<any> | undefined, plugin?: keyof SimpleGitOptions | undefined, message?: string);
}

View file

@ -0,0 +1,32 @@
import { GitError } from './git-error';
/**
* The `GitResponseError` is the wrapper for a parsed response that is treated as
* a fatal error, for example attempting a `merge` can leave the repo in a corrupted
* state when there are conflicts so the task will reject rather than resolve.
*
* For example, catching the merge conflict exception:
*
* ```typescript
import { gitP, SimpleGit, GitResponseError, MergeSummary } from 'simple-git';
const git = gitP(repoRoot);
const mergeOptions: string[] = ['--no-ff', 'other-branch'];
const mergeSummary: MergeSummary = await git.merge(mergeOptions)
.catch((e: GitResponseError<MergeSummary>) => e.git);
if (mergeSummary.failed) {
// deal with the error
}
```
*/
export declare class GitResponseError<T = any> extends GitError {
/**
* `.git` access the parsed response that is treated as being an error
*/
readonly git: T;
constructor(
/**
* `.git` access the parsed response that is treated as being an error
*/
git: T, message?: string);
}

View file

@ -0,0 +1,12 @@
import { GitError } from './git-error';
/**
* The `TaskConfigurationError` is thrown when a command was incorrectly
* configured. An error of this kind means that no attempt was made to
* run your command through the underlying `git` binary.
*
* Check the `.message` property for more detail on why your configuration
* resulted in an error.
*/
export declare class TaskConfigurationError extends GitError {
constructor(message?: string);
}