Download kind should be an enumarated type from TS perspective to avo…

…id mistakes
openzim · Feb 10, 2025 · 9699603 · 9699603
1 parent 88bbeec
commit 9699603
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/src/Downloader.ts b/src/Downloader.ts
@@ -371,7 +371,7 @@ class Downloader {
     })
   }
 
-  public async downloadContent(_url: string, kind: string, retry = true): Promise<{ content: Buffer | string; contentType: string; setCookie: string | null }> {
+  public async downloadContent(_url: string, kind: DonwloadKind, retry = true): Promise<{ content: Buffer | string; contentType: string; setCookie: string | null }> {
     if (!_url) {
       throw new Error(`Parameter [${_url}] is not a valid url`)
     }
@@ -459,7 +459,7 @@ class Downloader {
     return null
   }
 
-  private getJSONCb = <T>(url: string, kind: string, handler: (...args: any[]) => any): void => {
+  private getJSONCb = <T>(url: string, kind: DonwloadKind, handler: (...args: any[]) => any): void => {
     logger.info(`Getting JSON from [${url}]`)
     axios
       .get<T>(url, this.jsonRequestOptions)
@@ -527,7 +527,7 @@ class Downloader {
     }
   }
 
-  private getContentCb = async (url: string, kind: string, handler: any): Promise<void> => {
+  private getContentCb = async (url: string, kind: DonwloadKind, handler: any): Promise<void> => {
     logger.info(`Downloading [${url}]`)
     try {
       if (this.optimisationCacheUrl && kind === 'image') {
@@ -645,7 +645,7 @@ class Downloader {
     }
   }
 
-  private backoffCall(handler: (...args: any[]) => void, url: string, kind: string, callback: (...args: any[]) => void | Promise<void>): void {
+  private backoffCall(handler: (...args: any[]) => void, url: string, kind: DonwloadKind, callback: (...args: any[]) => void | Promise<void>): void {
     const call = backoff.call(handler, url, kind, callback)
     call.setStrategy(this.backoffOptions.strategy)
     call.retryIf(this.backoffOptions.retryIf)

diff --git a/src/types.d.ts b/src/types.d.ts
@@ -14,6 +14,8 @@ declare module 'imagemin-webp'
 
 type DominoElement = any
 
+type DonwloadKind = 'image' | 'json' | 'media' | 'video' | 'subtitle' | 'module' | 'css' | 'data'
+
 type Callback = (err?: any, data?: any, extra?: any) => void
 interface KVS<T> {
   [key: string]: T
@@ -42,7 +44,7 @@ type FileDetail = {
   namespace?: string
   mult?: number
   width?: number
-  kind: string
+  kind: DonwloadKind
 }
 
 type ArticleRedirect = {