Merge pull request #373 from JammingBen/feat/export_prepare_file_from…

…_props

feat: export the prepareFileFromProps method

source/index.ts

@@ -2,5 +2,5 @@ export { createClient } from "./factory.js";
 export { getPatcher } from "./compat/patcher.js";
 export * from "./types.js";
 
-export { parseStat, parseXML, translateDiskSpace } from "./tools/dav.js";
+export { parseStat, parseXML, translateDiskSpace, prepareFileFromProps } from "./tools/dav.js";
 export { processResponsePayload } from "./response.js";

source/tools/dav.ts

@@ -108,6 +108,13 @@ export function parseXML(xml: string): Promise<DAVResult> {
     });
 }
 
+/**
+ * Get a file stat result from given DAV properties
+ * @param props DAV properties
+ * @param filename The filename for the file stat
+ * @param isDetailed Whether or not the raw props of the resource should be returned
+ * @returns A file stat result
+ */
 export function prepareFileFromProps(
     props: DAVResultResponseProps,
     filename: string,