Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: Replace typed-emitter with manual implementation of typed event emitter for AppUpdater #6858

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/flat-toys-guess.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"electron-updater": patch
---

Remove typed-emitter as a dev-dep for electron-updater
3 changes: 1 addition & 2 deletions packages/electron-updater/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,7 @@
"@types/fs-extra": "9.0.13",
"@types/js-yaml": "4.0.3",
"@types/lodash.escaperegexp": "4.1.6",
"@types/lodash.isequal": "4.5.5",
"typed-emitter": "^2.1.0"
"@types/lodash.isequal": "4.5.5"
},
"typings": "./out/main.d.ts",
"publishConfig": {
Expand Down
47 changes: 45 additions & 2 deletions packages/electron-updater/src/AppUpdater.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ import { GenericProvider } from "./providers/GenericProvider"
import { DOWNLOAD_PROGRESS, Logger, Provider, ResolvedUpdateFileInfo, UPDATE_DOWNLOADED, UpdateCheckResult, UpdateDownloadedEvent, UpdaterSignal } from "./main"
import { createClient, isUrlProbablySupportMultiRangeRequests } from "./providerFactory"
import { ProviderPlatform } from "./providers/Provider"
import type TypedEmitter from "typed-emitter"
import Session = Electron.Session
import { AuthInfo } from "electron"

Expand All @@ -42,7 +41,7 @@ export type AppUpdaterEvents = {
"appimage-filename-updated": (path: string) => void
}

export abstract class AppUpdater extends (EventEmitter as new () => TypedEmitter<AppUpdaterEvents>) {
export abstract class AppUpdater extends EventEmitter {
/**
* Whether to automatically download an update when it is found.
*/
Expand Down Expand Up @@ -222,6 +221,50 @@ export abstract class AppUpdater extends (EventEmitter as new () => TypedEmitter
}
}

on<EventName extends keyof AppUpdaterEvents>(eventName: EventName, listener: AppUpdaterEvents[EventName]): this {
super.on(eventName, listener)
return this
}

off<EventName extends keyof AppUpdaterEvents>(eventName: EventName, listener: AppUpdaterEvents[EventName]): this {
super.off(eventName, listener)
return this
}

once<EventName extends keyof AppUpdaterEvents>(eventName: EventName, listener: AppUpdaterEvents[EventName]): this {
super.once(eventName, listener)
return this
}

addListener<EventName extends keyof AppUpdaterEvents>(eventName: EventName, listener: AppUpdaterEvents[EventName]): this {
super.addListener(eventName, listener)
return this
}

prependListener<EventName extends keyof AppUpdaterEvents>(eventName: EventName, listener: AppUpdaterEvents[EventName]): this {
super.prependListener(eventName, listener)
return this
}

prependOnceListener<EventName extends keyof AppUpdaterEvents>(eventName: EventName, listener: AppUpdaterEvents[EventName]): this {
super.prependOnceListener(eventName, listener)
return this
}

removeListener<EventName extends keyof AppUpdaterEvents>(eventName: EventName, listener: AppUpdaterEvents[EventName]): this {
super.removeListener(eventName, listener)
return this
}

removeAllListeners<EventName extends keyof AppUpdaterEvents>(eventName: EventName): this {
super.removeAllListeners(eventName)
return this
}

emit<EventName extends keyof AppUpdaterEvents>(eventName: EventName, ...args: Parameters<AppUpdaterEvents[EventName]>): boolean {
return super.emit(eventName, ...args)
}

//noinspection JSMethodCanBeStatic,JSUnusedGlobalSymbols
getFeedURL(): string | null | undefined {
return "Deprecated. Do not use it."
Expand Down
8 changes: 0 additions & 8 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.