mirror of
https://github.com/FlipsideCrypto/DefinitelyTyped.git
synced 2026-02-06 10:56:53 +00:00
ee7bf679ae
* update(gh-pages): v3 bump This version (as per release notes) does not change API. So this just aligns with source code package version: https://github.com/tschaub/gh-pages/releases/tag/v3.0.0 Thanks! * Add `defaults` export as per PR check
60 lines
1.6 KiB
TypeScript
60 lines
1.6 KiB
TypeScript
// Type definitions for gh-pages 3.0
|
|
// Project: https://github.com/tschaub/gh-pages
|
|
// Definitions by: Daniel Rosenwasser <https://github.com/DanielRosenwasser>
|
|
// Piotr Błażejewicz <https://github.com/peterblazejewicz>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
export interface PublishOptions {
|
|
add?: boolean;
|
|
branch?: string;
|
|
dest?: string;
|
|
dotfiles?: boolean;
|
|
git?: string;
|
|
/**
|
|
* Push force new commit without parent history
|
|
* @default true
|
|
*/
|
|
history?: boolean;
|
|
message?: string;
|
|
only?: string;
|
|
push?: boolean;
|
|
remote?: string;
|
|
/**
|
|
* Removes files that match the given pattern (Ignored if used together with --add).
|
|
* By default, gh-pages removes everything inside the target branch auto-generated directory before copying the new files from dir.
|
|
* @default '.'
|
|
*/
|
|
remove?: string;
|
|
repo?: string;
|
|
silent?: boolean;
|
|
src?: string | string[];
|
|
tag?: string;
|
|
user?: null | {
|
|
name: string;
|
|
email: string;
|
|
};
|
|
}
|
|
|
|
export function publish(basePath: string, callback: (err: any) => void): void;
|
|
export function publish(basePath: string, config: PublishOptions, callback?: (err: any) => void): void;
|
|
|
|
export function clean(): void;
|
|
|
|
export interface Defaults {
|
|
dest: '.';
|
|
add: false;
|
|
git: 'git';
|
|
depth: 1;
|
|
dotfiles: false;
|
|
branch: 'gh-pages';
|
|
remote: string;
|
|
src: '**/*';
|
|
remove: '.';
|
|
push: true;
|
|
history: true;
|
|
message: 'Updates';
|
|
silent: false;
|
|
}
|
|
|
|
export const defaults: Readonly<Defaults>;
|