js-utils-kit 0.0.0 → 0.2.0

package/dist/file/index.d.ts

@@ -0,0 +1,75 @@
+import { ArchiverOptions } from 'archiver';
+export { ArchiverOptions } from 'archiver';
+
+/**
+ * Supported archive formats.
+ */
+type ArchiveFormat = 'zip' | 'tar';
+/**
+ * Configuration options.
+ */
+interface CreateArchiveOptions {
+    /**
+     * Archive format to use {@link ArchiveFormat}.
+     */
+    format: ArchiveFormat;
+    /**
+     * Path to the source directory that should be archived.
+     */
+    source: string;
+    /**
+     * Destination file path where the archive will be written
+     * @example
+     *  - For `zip` format: `dist.zip`
+     *  - For `tar` format: `dist.tar`
+     */
+    destination: string;
+    /**
+     * Additional options passed directly to the archiver library. See {@link ArchiverOptions}.
+     */
+    options?: ArchiverOptions;
+    /**
+     * Optional flag to enable internal logging. Useful for CLI mode.
+     */
+    log?: boolean;
+    /**
+     * Called after archiving is complete — receives total size in bytes.
+     */
+    onSuccess?: (bytes: number) => void;
+}
+/**
+ * Creates a {@link ArchiveFormat } archive from a specified directory.
+ *
+ * This function uses the `archiver` library to package a directory into an archive file.
+ * It supports optional compression for `zip` and returns a Promise that resolves
+ * when the archive is successfully created.
+ *
+ * @example
+ *
+ * Function usage:
+ *
+ * ```ts
+ * await createArchive({
+ *   format: "zip",
+ *   source: "dist/",
+ *   destination: "dist.zip",
+ * });
+ * ```
+ *
+ *  CLI usage:
+ * ```sh
+ * npx js-utils-kit createArchive -f zip -s dist -d dist.zip
+ * ```
+ *
+ * @param options - Archive creation options
+ * @returns A Promise that resolves when the archive is created
+ * @throws If an error occurs during the archiving process
+ */
+declare function createArchive({ format, source, destination, options, log, onSuccess, }: CreateArchiveOptions): Promise<void>;
+
+declare const _default: {
+    createArchive: typeof createArchive;
+};
+
+export { createArchive, _default as default };
+export type { ArchiveFormat, CreateArchiveOptions };