• Version 3.2.1
  • Published
  • 5.51 kB
  • No dependencies
  • MIT license


npm i @types/gh-pages
yarn add @types/gh-pages
pnpm add @types/gh-pages


TypeScript definitions for gh-pages



variable defaults

const defaults: Readonly<Defaults>;


    function clean

    clean: () => void;

      function getCacheDir

      getCacheDir: (optPath?: string) => string;
      • Get the cache directory.

      function publish

      publish: {
      (basePath: string, callback: (err: any) => void): void;
      (basePath: string, config: PublishOptions, callback?: (err: any) => void): void;


        interface Defaults

        interface Defaults {}

          property add

          add: false;

            property beforeAdd

            beforeAdd: null;

              property branch

              branch: 'gh-pages';

                property depth

                depth: 1;

                  property dest

                  dest: '.';

                    property dotfiles

                    dotfiles: false;

                      property git

                      git: 'git';

                        property history

                        history: true;

                          property message

                          message: 'Updates';

                            property push

                            push: true;

                              property remote

                              remote: string;

                                property remove

                                remove: '.';

                                  property silent

                                  silent: false;

                                    property src

                                    src: '**/*';

                                      interface Git

                                      interface Git {}

                                        property add

                                        add: (files: string | string[]) => Promise<this>;

                                          property checkout

                                          checkout: (remote: string, branch: string) => Promise<this>;

                                            property clean

                                            clean: () => Promise<this>;

                                              property clone

                                              clone: (
                                              repo: string,
                                              dir: string,
                                              branch: string,
                                              options: PublishOptions
                                              ) => Promise<this>;

                                                property commit

                                                commit: (message: string) => Promise<this>;

                                                  property deleteRef

                                                  deleteRef: (branch: string) => Promise<this>;

                                                    property exec

                                                    exec: (command: string) => Promise<this>;

                                                      property fetch

                                                      fetch: (remote: string) => Promise<this>;

                                                        property getRemoteUrl

                                                        getRemoteUrl: (remote: string) => Promise<this>;

                                                          property init

                                                          init: () => Promise<this>;

                                                            property push

                                                            push: (remote: string, branch: string, force?: boolean) => Promise<this>;

                                                              property reset

                                                              reset: (remote: string, branch: string) => Promise<this>;

                                                                property rm

                                                                rm: (files: string | string[]) => Promise<this>;

                                                                  property tag

                                                                  tag: (name: string) => Promise<this>;

                                                                    interface PublishOptions

                                                                    interface PublishOptions {}

                                                                      property add

                                                                      add?: boolean | undefined;

                                                                        property beforeAdd

                                                                        beforeAdd?: ((git: Git) => Promise<Git | undefined>) | null | undefined;

                                                                          property branch

                                                                          branch?: string | undefined;

                                                                            property dest

                                                                            dest?: string | undefined;

                                                                              property dotfiles

                                                                              dotfiles?: boolean | undefined;

                                                                                property git

                                                                                git?: string | undefined;

                                                                                  property history

                                                                                  history?: boolean | undefined;
                                                                                  • Push force new commit without parent history true

                                                                                  property message

                                                                                  message?: string | undefined;

                                                                                    property only

                                                                                    only?: string | undefined;

                                                                                      property push

                                                                                      push?: boolean | undefined;

                                                                                        property remote

                                                                                        remote?: string | undefined;

                                                                                          property remove

                                                                                          remove?: string | undefined;
                                                                                          • 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. '.'

                                                                                          property repo

                                                                                          repo?: string | undefined;

                                                                                            property silent

                                                                                            silent?: boolean | undefined;

                                                                                              property src

                                                                                              src?: string | string[] | undefined;

                                                                                                property tag

                                                                                                tag?: string | undefined;

                                                                                                  property user

                                                                                                  | null
                                                                                                  | {
                                                                                                  name: string;
                                                                                                  email: string;
                                                                                                  | undefined;

                                                                                                    Package Files (1)

                                                                                                    Dependencies (0)

                                                                                                    No dependencies.

                                                                                                    Dev Dependencies (0)

                                                                                                    No dev dependencies.

                                                                                                    Peer Dependencies (0)

                                                                                                    No peer dependencies.


                                                                                                    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                                                    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/gh-pages.

                                                                                                    • Markdown
                                                                                                    • HTML
                                                                                                      <a href="https://www.jsdocs.io/package/@types/gh-pages"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>