@spinajs/fs 2.0.180 → 2.0.182

package/lib/cjs/local-provider.d.ts

@@ -1,101 +1,97 @@
-/// <reference types="node" />
-/// <reference types="node" />
-import { ReadStream } from 'fs';
-import { fs, IFsLocalOptions, IStat, IZipResult } from './interfaces.js';
-import { Log } from '@spinajs/log-common';
-/**
- * Abstract layer for file operations.
- * Basic implementation is just wrapper for native node fs functions
- *
- * It allows to wrap other libs eg. aws s3, ftp
- * and inject it into code without changing logic that use them.
- *
- * TODO: map errors to some kind of common errors shared with other implementations
- */
-export declare class fsNative<T extends IFsLocalOptions> extends fs {
-    Options: T;
-    protected Logger: Log;
-    /**
-     * Name of provider. We can have multiple providers of the same type but with different options.
-     * Also used in InjectService decorator for mapping
-     */
-    get Name(): string;
-    constructor(Options: T);
-    resolve(): Promise<void>;
-    /**
-     *
-     * Tries to download file to local filesystem, then returns local filesystem path.
-     * Native implementation simply returns local path and does nothing.
-     *
-     * @param path - file to download
-     */
-    download(path: string): Promise<string>;
-    upload(srcPath: string, destPath?: string): Promise<void>;
-    /**
-     * read all content of file
-     */
-    read(path: string, encoding?: BufferEncoding): Promise<string | Buffer>;
-    readStream(path: string, encoding?: BufferEncoding): Promise<ReadStream>;
-    /**
-     * Write to file string or buffer
-     */
-    write(path: string, data: string | Buffer, encoding: BufferEncoding): Promise<void>;
-    append(path: string, data: string | Buffer, encoding?: BufferEncoding): Promise<void>;
-    writeStream(path: string, rStream?: BufferEncoding | ReadStream, encoding?: BufferEncoding): Promise<import("fs").WriteStream>;
-    /**
-     * Checks if file existst
-     * @param path - path to check
-     */
-    exists(path: string): Promise<boolean>;
-    dirExists(path: string): Promise<boolean>;
-    /**
-     * Copy file to another location
-     * @param path - src path
-     * @param dest - dest path
-     */
-    copy(path: string, dest: string): Promise<void>;
-    /**
-     * Copy file to another location and deletes src file
-     */
-    move(oldPath: string, newPath: string): Promise<void>;
-    /**
-     * Change name of a file
-     */
-    rename(oldPath: string, newPath: string): Promise<void>;
-    /**
-     * Deletes file permanently
-     *
-     * @param path - path to file that will be deleted
-     * @param onlyTemp - remote filesystems need to download file before, if so, calling unlink with this flag removes only local temp file after we finished processing
-     */
-    unlink(path: string, onlyTemp?: boolean): Promise<void>;
-    /**
-     *
-     * Deletes dir recursively & all contents inside
-     *
-     * @param path - dir to remove
-     */
-    rm(path: string): Promise<void>;
-    /**
-     *
-     * Creates directory, recursively
-     *
-     * @param path - directory to create
-     */
-    mkdir(path: string): Promise<void>;
-    /**
-     * Returns file statistics, not all fields may be accesible
-     */
-    stat(path: string): Promise<IStat>;
-    tmppath(): string;
-    /**
-     * List content of directory
-     *
-     * @param path - path to directory
-     */
-    list(path: string): Promise<string[]>;
-    unzip(path: string, destPath: string): Promise<void>;
-    zip(path: string, zName?: string): Promise<IZipResult>;
-    resolvePath(path: string): string;
-}
+/// <reference types="node" />
+/// <reference types="node" />
+/// <reference types="node" />
+import { ReadStream } from 'fs';
+import { fs, IFsLocalOptions, IStat, IZipResult } from './interfaces.js';
+import { Log } from '@spinajs/log-common';
+/**
+ * Abstract layer for file operations.
+ * Basic implementation is just wrapper for native node fs functions
+ *
+ * It allows to wrap other libs eg. aws s3, ftp
+ * and inject it into code without changing logic that use them.
+ *
+ * TODO: map errors to some kind of common errors shared with other implementations
+ */
+export declare class fsNative<T extends IFsLocalOptions> extends fs {
+    Options: T;
+    protected Logger: Log;
+    /**
+     * Name of provider. We can have multiple providers of the same type but with different options.
+     * Also used in InjectService decorator for mapping
+     */
+    get Name(): string;
+    constructor(Options: T);
+    resolve(): Promise<void>;
+    /**
+     *
+     * Tries to download file to local filesystem, then returns local filesystem path.
+     * Native implementation simply returns local path and does nothing.
+     *
+     * @param path - file to download
+     */
+    download(path: string): Promise<string>;
+    upload(srcPath: string, destPath?: string): Promise<void>;
+    /**
+     * read all content of file
+     */
+    read(path: string, encoding?: BufferEncoding): Promise<string | Buffer>;
+    readStream(path: string, encoding?: BufferEncoding): Promise<ReadStream>;
+    /**
+     * Write to file string or buffer
+     */
+    write(path: string, data: string | Buffer, encoding: BufferEncoding): Promise<void>;
+    append(path: string, data: string | Buffer, encoding?: BufferEncoding): Promise<void>;
+    writeStream(path: string, rStream?: BufferEncoding | NodeJS.ReadStream, encoding?: BufferEncoding): Promise<import("fs").WriteStream>;
+    /**
+     * Checks if file existst
+     * @param path - path to check
+     */
+    exists(path: string): Promise<boolean>;
+    dirExists(path: string): Promise<boolean>;
+    /**
+     * Copy file or dir to another location
+     * @param path - src path
+     * @param dest - dest path
+     */
+    copy(path: string, dest: string, dstFs?: fs): Promise<void>;
+    /**
+     * Copy file to another location and deletes src file
+     */
+    move(oldPath: string, newPath: string, dstFs?: fs): Promise<void>;
+    /**
+     * Change name of a file
+     */
+    rename(oldPath: string, newPath: string): Promise<void>;
+    /**
+     *
+     * Deletes file OR
+     * Deletes dir recursively & all contents inside
+     *
+     * @param path - dir to remove
+     */
+    rm(path: string): Promise<void>;
+    /**
+     *
+     * Creates directory, recursively
+     *
+     * @param path - directory to create
+     */
+    mkdir(path: string): Promise<void>;
+    /**
+     * Returns file statistics, not all fields may be accesible
+     */
+    stat(path: string): Promise<IStat>;
+    tmppath(): string;
+    /**
+     * List content of directory
+     *
+     * @param path - path to directory
+     */
+    list(path: string): Promise<string[]>;
+    unzip(path: string, destPath?: string, dstFs?: fs): Promise<void>;
+    isDir(path: string): Promise<boolean>;
+    zip(path: string | string[], dstFs?: fs, dstFile?: string): Promise<IZipResult>;
+    resolvePath(path: string): string;
+}
 //# sourceMappingURL=local-provider.d.ts.map

package/lib/cjs/local-provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"local-provider.d.ts","sourceRoot":"","sources":["../../src/local-provider.ts"],"names":[],"mappings":";;AAEA,OAAO,EAQL,UAAU,EACX,MAAM,IAAI,CAAC;AAIZ,OAAO,EAAE,EAAE,EAAE,eAAe,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAEzE,OAAO,EAAE,GAAG,EAAU,MAAM,qBAAqB,CAAC;AAIlD;;;;;;;;GAQG;AACH,qBAEa,QAAQ,CAAC,CAAC,SAAS,eAAe,CAAE,SAAQ,EAAE;IAYtC,OAAO,EAAE,CAAC;IAV7B,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC;IAEtB;;;OAGG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;gBAEkB,OAAO,EAAE,CAAC;IAIhB,OAAO;IAepB;;;;;;OAMG;IACU,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IASvC,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM;IAStD;;OAEG;IACU,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc;IAYlD,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc;IAIzD;;OAEG;IACU,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,EAAE,cAAc;IAKnE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3F,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,EAAE,QAAQ,CAAC,EAAE,cAAc;IAQjG;;;OAGG;IACU,MAAM,CAAC,IAAI,EAAE,MAAM;IASnB,SAAS,CAAC,IAAI,EAAE,MAAM;IAInC;;;;OAIG;IACU,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM;IAI5C;;OAEG;IACU,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAgBlD;;OAEG;IACU,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAIpD;;;;;OAKG;IACU,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,OAAO;IASpD;;;;;OAKG;IACU,EAAE,CAAC,IAAI,EAAE,MAAM;IAI5B;;;;;OAKG;IACU,KAAK,CAAC,IAAI,EAAE,MAAM;IAI/B;;OAEG;IACU,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAaxC,OAAO,IAAI,MAAM;IAIxB;;;;OAIG;IACU,IAAI,CAAC,IAAI,EAAE,MAAM;IAIjB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM;IAapC,GAAG,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAqC5D,WAAW,CAAC,IAAI,EAAE,MAAM;CAOhC"}
+{"version":3,"file":"local-provider.d.ts","sourceRoot":"","sources":["../../src/local-provider.ts"],"names":[],"mappings":";;;AAEA,OAAO,EAAsF,UAAU,EAAE,MAAM,IAAI,CAAC;AAIpH,OAAO,EAAE,EAAE,EAAE,eAAe,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAEzE,OAAO,EAAE,GAAG,EAAU,MAAM,qBAAqB,CAAC;AAMlD;;;;;;;;GAQG;AACH,qBAEa,QAAQ,CAAC,CAAC,SAAS,eAAe,CAAE,SAAQ,EAAE;IAYtC,OAAO,EAAE,CAAC;IAV7B,SAAS,CAAC,MAAM,EAAE,GAAG,CAAC;IAEtB;;;OAGG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;gBAEkB,OAAO,EAAE,CAAC;IAIhB,OAAO;IAgBpB;;;;;;OAMG;IACU,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IASvC,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM;IAStD;;OAEG;IACU,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc;IAYlD,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc;IAIzD;;OAEG;IACU,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,EAAE,cAAc;IAgBnE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;IAI3F,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,EAAE,cAAc;IAYxG;;;OAGG;IACU,MAAM,CAAC,IAAI,EAAE,MAAM;IASnB,SAAS,CAAC,IAAI,EAAE,MAAM;IAInC;;;;OAIG;IACU,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE;IAkBxD;;OAEG;IACU,IAAI,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE;IAY9D;;OAEG;IACU,MAAM,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAIpD;;;;;;OAMG;IACU,EAAE,CAAC,IAAI,EAAE,MAAM;IAI5B;;;;;OAKG;IACU,KAAK,CAAC,IAAI,EAAE,MAAM;IAI/B;;OAEG;IACU,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAaxC,OAAO,IAAI,MAAM;IAIxB;;;;OAIG;IACU,IAAI,CAAC,IAAI,EAAE,MAAM;IAIjB,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,EAAE;IAgBjD,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IASrC,GAAG,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAgErF,WAAW,CAAC,IAAI,EAAE,MAAM;CAIhC"}