electron-publish

  • Version 23.0.0-alpha.0
  • Published
  • 73.5 kB
  • 7 dependencies
  • MIT license

Install

npm i electron-publish
yarn add electron-publish
pnpm add electron-publish

Overview

Part of [electron-builder](https://github.com/electron-userland/electron-builder).

Index

Functions

function getCiTag

getCiTag: () => string | null;

    Classes

    class HttpPublisher

    abstract class HttpPublisher extends Publisher {}

      constructor

      protected constructor(context: PublishContext, useSafeArtifactName?: boolean);

        property context

        protected readonly context: PublishContext;

          method doUpload

          protected abstract doUpload: (
          fileName: string,
          arch: Arch,
          dataLength: number,
          requestProcessor: (
          request: ClientRequest,
          reject: (error: Error) => void
          ) => void,
          file: string
          ) => Promise<any>;

            method upload

            upload: (task: UploadTask) => Promise<any>;

              class ProgressCallback

              class ProgressCallback {}

                constructor

                constructor(progressBar: ProgressBar);

                  method update

                  update: (transferred: number, total: number) => void;

                    class Publisher

                    abstract class Publisher {}

                      constructor

                      protected constructor(context: PublishContext);

                        property context

                        protected readonly context: PublishContext;

                          property providerName

                          readonly providerName: PublishProvider;

                            method createProgressBar

                            protected createProgressBar: (
                            fileName: string,
                            size: number
                            ) => ProgressBar | null;

                              method createReadStreamAndProgressBar

                              protected createReadStreamAndProgressBar: (
                              file: string,
                              fileStat: Stats,
                              progressBar: ProgressBar | null,
                              reject: (error: Error) => void
                              ) => NodeJS.ReadableStream;

                                method toString

                                abstract toString: () => string;

                                  method upload

                                  abstract upload: (task: UploadTask) => Promise<any>;

                                    Interfaces

                                    interface PublishContext

                                    interface PublishContext {}

                                      property cancellationToken

                                      readonly cancellationToken: CancellationToken;

                                        property progress

                                        readonly progress: MultiProgress | null;

                                          interface PublishOptions

                                          interface PublishOptions {}

                                            property publish

                                            publish?: PublishPolicy | null;

                                              interface UploadTask

                                              interface UploadTask {}

                                                property arch

                                                arch: Arch | null;

                                                  property file

                                                  file: string;

                                                    property fileContent

                                                    fileContent?: Buffer | null;

                                                      property safeArtifactName

                                                      safeArtifactName?: string | null;

                                                        Type Aliases

                                                        type PublishPolicy

                                                        type PublishPolicy = 'onTag' | 'onTagOrDraft' | 'always' | 'never';

                                                          Package Files (2)

                                                          Dependencies (7)

                                                          Dev Dependencies (1)

                                                          Peer Dependencies (0)

                                                          No peer dependencies.

                                                          Badge

                                                          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/electron-publish.

                                                          • Markdown
                                                            [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/electron-publish)
                                                          • HTML
                                                            <a href="https://www.jsdocs.io/package/electron-publish"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>