Merge pull request #309 from magicdawn/feat-get-filecontents-overload

feat: add ts overload to getFileContents
perry-mitchell · Aug 21, 2022 · 1703129 · 1703129
2 parents 0cd3c8a + 45d1661
commit 1703129
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 1 deletion.
diff --git a/.editorconfig b/.editorconfig
@@ -2,7 +2,7 @@
 end_of_line = lf
 insert_final_newline = true
 
-[*.{js,json}]
+[*.{js,json,ts}]
 indent_style = space
 indent_size = 4
 

diff --git a/source/operations/getFileContents.ts b/source/operations/getFileContents.ts
@@ -15,6 +15,30 @@ import {
 
 const TRANSFORM_RETAIN_FORMAT = (v: any) => v;
 
+type GetFileContentsBasicOptions = Omit<GetFileContentsOptions, "format" | "details">;
+
+export async function getFileContents(
+    context: WebDAVClientContext,
+    filePath: string,
+    options?: GetFileContentsBasicOptions & { format?: "binary"; details?: false }
+): Promise<BufferLike>;
+export async function getFileContents(
+    context: WebDAVClientContext,
+    filePath: string,
+    options: GetFileContentsBasicOptions & { format: "text"; details?: false }
+): Promise<string>;
+// details
+export async function getFileContents(
+    context: WebDAVClientContext,
+    filePath: string,
+    options: GetFileContentsBasicOptions & { format?: "binary"; details: true }
+): Promise<ResponseDataDetailed<BufferLike>>;
+export async function getFileContents(
+    context: WebDAVClientContext,
+    filePath: string,
+    options: GetFileContentsBasicOptions & { format: "text"; details: true }
+): Promise<ResponseDataDetailed<string>>;
+
 export async function getFileContents(
     context: WebDAVClientContext,
     filePath: string,