feat: allow passing in user agent

flybywiresim · Aug 13, 2023 · eb847b2 · eb847b2
1 parent 60bba59
commit eb847b2
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/src/core/fragmenter-context.ts b/src/core/fragmenter-context.ts
@@ -40,6 +40,7 @@ export class FragmenterContext extends (EventEmitter as new () => TypedEventEmit
             useConsoleLog: true,
             forceCacheBust: false,
             logTrace: false,
+            userAgent: undefined,
             ...options,
         };
 

diff --git a/src/install/stream-downloader.ts b/src/install/stream-downloader.ts
@@ -94,6 +94,10 @@ export class StreamDownloader extends (EventEmitter as new () => TypedEventEmitt
     private async getReadStream(startIndex: number, url: string): Promise<AxiosResponse<stream.Readable>> {
         const headers: AxiosRequestHeaders = {};
 
+        if (this.ctx.options.userAgent !== undefined) {
+            headers['User-Agent'] = this.ctx.options.userAgent;
+        }
+
         if (startIndex !== 0) {
             headers.Range = `bytes=${startIndex}-`;
         }

diff --git a/src/types.ts b/src/types.ts
@@ -120,6 +120,13 @@ export interface BaseCommandOptions {
      * Defaults to `false`,
      */
     logTrace: boolean,
+
+    /**
+     * The user agent to use for HTTP requests.
+     *
+     * Defaults to the Axios user agent.
+     */
+    userAgent?: string,
 }
 
 export type PackOptions = Partial<BaseCommandOptions> & {