Skip to content

Commit f7bc9ca

Browse files
committed
feat: update close method documentation in DownloadEngineNodejs for clarity and improve SuggestedEventName type for better type safety
1 parent 80e530e commit f7bc9ca

2 files changed

Lines changed: 4 additions & 3 deletions

File tree

src/download/download-engine/engine/download-engine-nodejs.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,8 +113,9 @@ export default class DownloadEngineNodejs<T extends DownloadEngineWriteStreamNod
113113

114114
/**
115115
* Close the download engine
116-
* @param deleteTempFile {boolean} - delete the temp file (when the download is **not finished**).
117-
* @param deleteFile {boolean} - delete the **temp** or **final file** (clean everything up).
116+
* @param options - close options.
117+
* @param options.deleteTempFile - delete the temp file (when the download is **not finished**).
118+
* @param options.deleteFile - delete the **temp** or **final file** (clean everything up).
118119
*/
119120
override async close({deleteTempFile, deleteFile}: { deleteTempFile?: boolean, deleteFile?: boolean; } = {}): Promise<void> {
120121
await super.close();

src/utils/EventEmitter.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ type KnownEventName<Events extends object> = Extract<{
1919
}[keyof Events], EventName>;
2020
type EventListener<Events extends object, Key extends EventName> = Key extends keyof Events ? Events[Key] extends AnyListener ? Events[Key] : never : AnyListener;
2121
type EventListenerArgs<Events extends object, Key extends EventName> = ListenerArgs<EventListener<Events, Key>>;
22-
type SuggestedEventName<Events extends object, ExtraEvents extends EventName> = KnownEventName<Events> | (ExtraEvents & object);
22+
type SuggestedEventName<Events extends object, ExtraEvents extends EventName> = KnownEventName<Events> | (ExtraEvents & NonNullable<unknown>);
2323
type HasBroadEventKeys<Events extends object> = string extends keyof Events ? true : symbol extends keyof Events ? true : false;
2424
type DefaultExtraEvents<Events extends object> = HasBroadEventKeys<Events> extends true ? EventName : never;
2525

0 commit comments

Comments
 (0)