fix: add filename to export response on toolbox

kitsonk · Sep 15, 2024 · af2441a · af2441a
1 parent 6bf5d7d
commit af2441a
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/deno.json b/deno.json
@@ -1,6 +1,6 @@
 {
   "name": "@kitsonk/kv-toolbox",
-  "version": "0.19.0-beta.5",
+  "version": "0.19.0-beta.6",
   "exports": {
     ".": "./toolbox.ts",
     "./batched_atomic": "./batched_atomic.ts",

diff --git a/toolbox.ts b/toolbox.ts
@@ -290,7 +290,16 @@ export class KvToolbox implements Disposable {
    */
   export(
     selector: Deno.KvListSelector,
-    options: { close?: boolean; response: true },
+    options: {
+      close?: boolean;
+      response: true;
+      /**
+       * If provided, the response will include a header that indicates the file is
+       * meant to be downloaded (`Content-Disposition`). The extension `.ndjson`
+       * will be appended to the filename.
+       */
+      filename?: string;
+    },
   ): Response;
   /**
    * Like {@linkcode Deno.Kv} `.list()` method, but returns a
@@ -316,7 +325,7 @@ export class KvToolbox implements Disposable {
   export(
     selector: Deno.KvListSelector,
     options:
-      | { close?: boolean; response: true }
+      | { close?: boolean; response: true; filename?: string }
       | (
         | ExportEntriesOptionsJSON
         | ExportEntriesOptionsBytes