@bouko/fs 0.0.3 → 0.0.4

package/dist/functions/file.d.ts

@@ -1,11 +1,26 @@
 import { EnsureFileOptions } from "../types/file";
+type ReadFilesOptions<T extends keyof FileReturnMap, K> = {
+    folderPath: string;
+    ext: T;
+    page?: number;
+    pageSize?: number;
+    formatter?: (x: FileReturnMap[T]) => K;
+    cache?: Map<string, K>;
+};
+export declare function readFiles<T extends "mp3" | "json", K = undefined>({ folderPath, ext, page, pageSize, formatter }: ReadFilesOptions<T, K>): Promise<{
+    items: (Awaited<K> & ({} | undefined))[];
+    page: number;
+    totalItems: number;
+    totalPages: number;
+}>;
 export declare function ensureFile(filePath: string, options?: EnsureFileOptions): Promise<void>;
 export declare function readJson<T>(filePath: string, fallback?: object): Promise<T>;
 type SpecialFile = {
+    path: string;
     buffer: ArrayBuffer;
     last_modified: Date;
 };
-type Mp3File = SpecialFile & {
+export type Mp3File = SpecialFile & {
     duration: number;
     metadata: {
         title: string;

package/dist/functions/file.js

@@ -1,7 +1,34 @@
 import fs from "fs/promises";
 import path from "path";
 import * as mm from "music-metadata";
-import { sanitizeArrayMap } from "@bouko/ts";
+import { sanitizeArrayMap, byName } from "@bouko/ts";
+export async function readFiles({ folderPath, ext, page = 0, pageSize = 20, formatter }) {
+    const entries = await fs.readdir(folderPath, { withFileTypes: true });
+    const filePaths = entries
+        .filter((e) => e.isFile() && e.name.toLowerCase().endsWith("." + ext))
+        .map((e) => path.join(folderPath, e.name))
+        .sort(byName);
+    const totalItems = filePaths.length;
+    const totalPages = Math.max(1, Math.ceil(totalItems / pageSize));
+    const safePage = Math.min(Math.max(page, 0), totalPages - 1);
+    const start = safePage * pageSize;
+    const items = filePaths.slice(start, start + pageSize);
+    const raw = await Promise.all(items.map(async (p) => {
+        try {
+            return await readFile(p).then(formatter);
+        }
+        catch {
+            return null;
+        }
+    }));
+    const final = raw.filter(x => x !== null);
+    return {
+        items: final,
+        page: safePage,
+        totalItems,
+        totalPages
+    };
+}
 export async function ensureFile(filePath, options) {
     const dirPath = path.dirname(filePath);
     await fs.mkdir(dirPath, { recursive: true });
@@ -58,6 +85,7 @@ export async function readFile(filePath, options) {
         const sanitized = sanitizeArrayMap(parsed);
         const buffer = await fs.readFile(filePath);
         return {
+            path: filePath,
             buffer: buffer.buffer.slice(buffer.byteOffset, buffer.byteOffset + buffer.byteLength),
             last_modified
         };
@@ -67,6 +95,7 @@ export async function readFile(filePath, options) {
         const { common, format } = await mm.parseFile(filePath, { duration: true });
         const pic = common.picture?.[0] ?? null;
         return {
+            path: filePath,
             buffer: buffer.buffer.slice(buffer.byteOffset, buffer.byteOffset + buffer.byteLength),
             metadata: {
                 title: common.title ?? path.basename(filePath),

package/package.json

@@ -1,7 +1,7 @@
 {
 
   "name": "@bouko/fs",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "license": "MIT",