https://www.electron.build/assets/js/1a59ea1b.847ed74e.js

1"use strict";(self.webpackChunk_electron_builder_website=self.webpackChunk_electron_builder_website||[]).push([["37869"],{52404(e,r,s){s.r(r),s.d(r,{metadata:()=>l,default:()=>a,frontMatter:()=>d,contentTitle:()=>c,toc:()=>t,assets:()=>h});var l=JSON.parse('{"id":"api/electron-publish.Class.GitHubPublisher","title":"Class: GitHubPublisher","description":"Extends","source":"@site/docs/api/electron-publish.Class.GitHubPublisher.md","sourceDirName":"api","slug":"/api/electron-publish.Class.GitHubPublisher","permalink":"/docs/api/electron-publish.Class.GitHubPublisher","draft":false,"unlisted":false,"editUrl":"https://github.com/electron-userland/electron-builder/edit/master/website/docs/api/electron-publish.Class.GitHubPublisher.md","tags":[],"version":"current","frontMatter":{}}'),n=s(8265),i=s(27248);let d={},c="Class: GitHubPublisher",h={},t=[{value:"Extends",id:"extends",level:2},{value:"Constructors",id:"constructors",level:2},{value:"Constructor",id:"constructor",level:3},{value:"Parameters",id:"parameters",level:4},{value:"context",id:"context",level:5},{value:"info",id:"info",level:5},{value:"version",id:"version",level:5},{value:"options?",id:"options",level:5},{value:"releaseBody?",id:"releasebody",level:5},{value:"releaseName?",id:"releasename",level:5},{value:"Returns",id:"returns",level:4},{value:"Overrides",id:"overrides",level:4},{value:"Properties",id:"properties",level:2},{value:"_release",id:"_release",level:3},{value:"context",id:"context-1",level:3},{value:"Inherited from",id:"inherited-from",level:4},{value:"providerName",id:"providername",level:3},{value:"Overrides",id:"overrides-1",level:4},{value:"Methods",id:"methods",level:2},{value:"createProgressBar()",id:"createprogressbar",level:3},{value:"Parameters",id:"parameters-1",level:4},{value:"fileName",id:"filename",level:5},{value:"size",id:"size",level:5},{value:"Returns",id:"returns-1",level:4},{value:"Inherited from",id:"inherited-from-1",level:4},{value:"createReadStreamAndProgressBar()",id:"createreadstreamandprogressbar",level:3},{value:"Parameters",id:"parameters-2",level:4},{value:"file",id:"file",level:5},{value:"fileStat",id:"filestat",level:5},{value:"progressBar",id:"progressbar",level:5},{value:"reject",id:"reject",level:5},{value:"Returns",id:"returns-2",level:4},{value:"Inherited from",id:"inherited-from-2",level:4},{value:"deleteRelease()",id:"deleterelease",level:3},{value:"Returns",id:"returns-3",level:4},{value:"doUpload()",id:"doupload",level:3},{value:"Parameters",id:"parameters-3",level:4},{value:"fileName",id:"filename-1",level:5},{value:"arch",id:"arch",level:5},{value:"dataLength",id:"datalength",level:5},{value:"requestProcessor",id:"requestprocessor",level:5},{value:"Returns",id:"returns-4",level:4},{value:"Overrides",id:"overrides-2",level:4},{value:"getRelease()",id:"getrelease",level:3},{value:"Returns",id:"returns-5",level:4},{value:"toString()",id:"tostring",level:3},{value:"Returns",id:"returns-6",level:4},{value:"Overrides",id:"overrides-3",level:4},{value:"upload()",id:"upload",level:3},{value:"Parameters",id:"parameters-4",level:4},{value:"task",id:"task",level:5},{value:"Returns",id:"returns-7",level:4},{value:"Inherited from",id:"inherited-from-3",level:4}];function o(e){let r={a:"a",blockquote:"blockquote",code:"code",h1:"h1",h2:"h2",h3:"h3",h4:"h4",h5:"h5",header:"header",hr:"hr",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...e.components};return(0,n.jsxs)(n.Fragment,{children:[(0,n.jsx)(r.header,{children:(0,n.jsx)(r.h1,{id:"class-githubpublisher",children:"Class: GitHubPublisher"})}),"\n",(0,n.jsx)(r.h2,{id:"extends",children:"Extends"}),"\n",(0,n.jsxs)(r.ul,{children:["\n",(0,n.jsx)(r.li,{children:(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Class.HttpPublisher",children:(0,n.jsx)(r.code,{children:"HttpPublisher"})})}),"\n"]}),"\n",(0,n.jsx)(r.h2,{id:"constructors",children:"Constructors"}),"\n",(0,n.jsx)(r.h3,{id:"constructor",children:"Constructor"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"new GitHubPublisher"}),"(",(0,n.jsx)(r.code,{children:"context"}),", ",(0,n.jsx)(r.code,{children:"info"}),", ",(0,n.jsx)(r.code,{children:"version"}),", ",(0,n.jsx)(r.code,{children:"options?"}),", ",(0,n.jsx)(r.code,{children:"releaseBody?"}),", ",(0,n.jsx)(r.code,{children:"releaseName?"}),"): ",(0,n.jsx)(r.code,{children:"GitHubPublisher"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"parameters",children:"Parameters"}),"\n",(0,n.jsx)(r.h5,{id:"context",children:"context"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Interface.PublishContext",children:(0,n.jsx)(r.code,{children:"PublishContext"})})}),"\n",(0,n.jsx)(r.h5,{id:"info",children:"info"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"/docs/api/builder

1-util-runtime.Interface.GithubOptions",children:(0,n.jsx)(r.code,{children:"GithubOptions"})})}),"\n",(0,n.jsx)(r.h5,{id:"version",children:"version"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"string"})}),"\n",(0,n.jsx)(r.h5,{id:"options",children:"options?"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Interface.PublishOptions",children:(0,n.jsx)(r.code,{children:"PublishOptions"})})," = ",(0,n.jsx)(r.code,{children:"{}"})]}),"\n",(0,n.jsx)(r.h5,{id:"releasebody",children:"releaseBody?"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"string"})," | ",(0,n.jsx)(r.code,{children:"null"})]}),"\n",(0,n.jsx)(r.h5,{id:"releasename",children:"releaseName?"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"string"})," | ",(0,n.jsx)(r.code,{children:"null"})]}),"\n",(0,n.jsx)(r.h4,{id:"returns",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"GitHubPublisher"})}),"\n",(0,n.jsx)(r.h4,{id:"overrides",children:"Overrides"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Class.HttpPublisher",children:(0,n.jsx)(r.code,{children:"HttpPublisher"})}),".",(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Class.HttpPublisher#constructor",children:(0,n.jsx)(r.code,{children:"constructor"})})]}),"\n",(0,n.jsx)(r.h2,{id:"properties",children:"Properties"}),"\n",(0,n.jsx)(r.h3,{id:"_release",children:"_release"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"readonly"})," ",(0,n.jsx)(r.strong,{children:"_release"}),": ",(0,n.jsx)(r.code,{children:"Lazy"}),"<",(0,n.jsx)(r.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"context-1",children:"context"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"protected"})," ",(0,n.jsx)(r.code,{children:"readonly"})," ",(0,n.jsx)(r.strong,{children:"context"}),": ",(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Interface.PublishContext",children:(0,n.jsx)(r.code,{children:"PublishContext"})})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from",children:"Inherited from"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Class.HttpPublisher",children:(0,n.jsx)(r.code,{children:"HttpPublisher"})}),".",(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Class.HttpPublisher#context",children:(0,n.jsx)(r.code,{children:"context"})})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"providername",children:"providerName"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"readonly"})," ",(0,n.jsx)(r.strong,{children:"providerName"}),": ",(0,n.jsx)(r.code,{children:'"github"'})," = ",(0,n.jsx)(r.code,{children:'"github"'})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"overrides-1",children:"Overrides"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Class.HttpPublisher",children:(0,n.jsx)(r.code,{children:"HttpPublisher"})}),".",(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Class.HttpPublisher#providername",children:(0,n.jsx)(r.code,{children:"providerName"})})]}),"\n",(0,n.jsx)(r.h2,{id:"methods",children:"Methods"}),"\n",(0,n.jsx)(r.h3,{id:"createprogressbar",children:"createProgressBar()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"protected"})," ",(0,n.jsx)(r.strong,{children:"createProgressBar"}),"(",(0,n.jsx)(r.code,{children:"fileName"}),", ",(0,n.jsx)(r.code,{children:"size"}),"): ",(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Class.ProgressBar",children:(0,n.jsx)(r.code,{children:"ProgressBar"})})," | ",(0,n.jsx)(r.code,{children:"null"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"parameters-1",children:"Parameters"}),"\n",(0,n.jsx)(r.h5,{id:"filename",children:"fileName"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"string"})}),"\n",(0,n.jsx)(r.h5,{id:"size",children:"size"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"number"})}),"\n",(0,n.jsx)(r.h4,{id:"returns-1",children:"Returns"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Class.ProgressBar",children:(0,n.jsx)(r.code,{children:"ProgressBar"})})," | ",(0,n.jsx)(r.code,{children:"null"})]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-1",children:"Inherited from"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Class.HttpPublisher",children:(0,n.jsx)(r.code,{children:"HttpPublisher"})}),".",(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Class.HttpPublisher#createprogressbar",children:(0,n.jsx)(r.code,{children:"createProgressBar"})})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"createreadstreamandprogressbar",children:"createReadStreamAndProgressBar()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"protected"})," ",(0,n.jsx)(r.strong,{children:"createReadStreamAndProgressBar"}),"(",(0,n.jsx)(r.code,{children:"file"}),", ",(0,n.jsx)(r.code,{children:"fileStat"}),", ",(0,n.jsx)(r.code,{children:"progressBar"}),", ",(0,n.jsx)(r.code,{children:"reject"}),"): ",(0,n.jsx)(r.code,{children:"ReadableStream"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"parameters-2",children:"Parameters"}),"\n",(0,n.jsx)(r.h5,{id:"file",children:"file"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"string"})}),"\n",(0,n.jsx)(r.h5,{id:"filestat",children:"fileStat"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"Stats"})}),"\n",(0,n.jsx)(r.h5,{id:"progressbar",children:"progressBar"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Class.ProgressBar",children:(0,n.jsx)(r.code,{children:"ProgressBar"})})," | ",(0,n.jsx)(r.code,{children:"null"})]}),"\n",(0,n.jsx)(r.h5,{id:"reject",children:"reject"}),"\n",(0,n.jsxs)(r.p,{children:["(",(0,n.jsx)(r.code,{children:"error"}),") => ",(0,n.jsx)(r.code,{children:"void"})]}),"\n",(0,n.jsx)(r.h4,{id:"returns-2",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"ReadableStream"})}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-2",children:"Inherited from"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Class.HttpPublisher",children:(0,n.jsx)(r.code,{children:"HttpPublisher"})}),".",(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Class.HttpPublisher#createreadstreamandprogressbar",children:(0,n.jsx)(r.code,{children:"createReadStreamAndProgressBar"})})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"deleterelease",children:"deleteRelease()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"deleteRelease"}),"(): ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"returns-3",children:"Returns"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"any"}),">"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"doupload",children:"doUpload()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"protected"})," ",(0,n.jsx)(r.strong,{children:"doUpload"}),"(",(0,n.jsx)(r.code,{children:"fileName"}),", ",(0,n.jsx)(r.code,{children:"arch"}),", ",(0,n.jsx)(r.code,{children:"dataLength"}),", ",(0,n.jsx)(r.code,{children:"requestProcessor"}),"): ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"parameters-3",children:"Parameters"}),"\n",(0,n.jsx)(r.h5,{id:"filename-1",children:"fileName"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"string"})}

1),"\n",(0,n.jsx)(r.h5,{id:"arch",children:"arch"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"/docs/api/app-builder-lib.Enumeration.Arch",children:(0,n.jsx)(r.code,{children:"Arch"})})}),"\n",(0,n.jsx)(r.h5,{id:"datalength",children:"dataLength"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"number"})}),"\n",(0,n.jsx)(r.h5,{id:"requestprocessor",children:"requestProcessor"}),"\n",(0,n.jsxs)(r.p,{children:["(",(0,n.jsx)(r.code,{children:"request"}),", ",(0,n.jsx)(r.code,{children:"reject"}),") => ",(0,n.jsx)(r.code,{children:"void"})]}),"\n",(0,n.jsx)(r.h4,{id:"returns-4",children:"Returns"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"any"}),">"]}),"\n",(0,n.jsx)(r.h4,{id:"overrides-2",children:"Overrides"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Class.HttpPublisher",children:(0,n.jsx)(r.code,{children:"HttpPublisher"})}),".",(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Class.HttpPublisher#doupload",children:(0,n.jsx)(r.code,{children:"doUpload"})})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"getrelease",children:"getRelease()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"getRelease"}),"(): ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"returns-5",children:"Returns"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"any"}),">"]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"tostring",children:"toString()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"toString"}),"(): ",(0,n.jsx)(r.code,{children:"string"})]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"returns-6",children:"Returns"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.code,{children:"string"})}),"\n",(0,n.jsx)(r.h4,{id:"overrides-3",children:"Overrides"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Class.HttpPublisher",children:(0,n.jsx)(r.code,{children:"HttpPublisher"})}),".",(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Class.HttpPublisher#tostring",children:(0,n.jsx)(r.code,{children:"toString"})})]}),"\n",(0,n.jsx)(r.hr,{}),"\n",(0,n.jsx)(r.h3,{id:"upload",children:"upload()"}),"\n",(0,n.jsxs)(r.blockquote,{children:["\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.strong,{children:"upload"}),"(",(0,n.jsx)(r.code,{children:"task"}),"): ",(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"any"}),">"]}),"\n"]}),"\n",(0,n.jsx)(r.h4,{id:"parameters-4",children:"Parameters"}),"\n",(0,n.jsx)(r.h5,{id:"task",children:"task"}),"\n",(0,n.jsx)(r.p,{children:(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Interface.UploadTask",children:(0,n.jsx)(r.code,{children:"UploadTask"})})}),"\n",(0,n.jsx)(r.h4,{id:"returns-7",children:"Returns"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.code,{children:"Promise"}),"<",(0,n.jsx)(r.code,{children:"any"}),">"]}),"\n",(0,n.jsx)(r.h4,{id:"inherited-from-3",children:"Inherited from"}),"\n",(0,n.jsxs)(r.p,{children:[(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Class.HttpPublisher",children:(0,n.jsx)(r.code,{children:"HttpPublisher"})}),".",(0,n.jsx)(r.a,{href:"/docs/api/electron-publish.Class.HttpPublisher#upload",children:(0,n.jsx)(r.code,{children:"upload"})})]})]})}function a(e={}){let{wrapper:r}={...(0,i.R)(),...e.components};return r?(0,n.jsx)(r,{...e,children:(0,n.jsx)(o,{...e})}):o(e)}},27248(e,r,s){s.d(r,{R:()=>d,x:()=>c});var l=s(70141);let n={},i=l.createContext(n);function d(e){let r=l.useContext(i);return l.useMemo(function(){return"function"==typeof e?e(r):{...r,...e}},[r,e])}function c(e){let r;return r=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:d(e.components),l.createElement(i.Provider,{value:r},e.children)}}}]);