tar-vern 0.1.0

package/dist/utils.d.ts

@@ -0,0 +1,45 @@
+/*!
+ * name: tar-vern
+ * version: 0.1.0
+ * description: Tape archiver library for Typescript
+ * author: Kouji Matsui (@kekyo@mi.kekyo.net)
+ * license: MIT
+ * repository.url: https://github.com/kekyo/tar-vern.git
+ */
+
+import { Readable } from 'stream';
+import { CreateItemOptions, CreateReadableItemOptions, FileItem, DirectoryItem, ReflectStats, CreateDirectoryItemOptions } from './types';
+/**
+ * Create a DirectoryItem
+ * @param path - The path to the directory in the tar archive
+ * @param reflectStat - Whether to reflect optional stat of the file (mode, uid, gid, mtime. Default: 'none')
+ * @param options - Metadata for the directory including path in tar archive
+ * @returns A DirectoryItem
+ * @remarks When reflectStat is 'all' or 'exceptName', `options.directoryPath` must be provided.
+ */
+export declare const createDirectoryItem: (path: string, reflectStat?: ReflectStats, options?: CreateDirectoryItemOptions) => Promise<DirectoryItem>;
+/**
+ * Create a FileItem from a Readable stream
+ * @param path - The path to the file in the tar archive
+ * @param reader - The readable stream
+ * @param options - Metadata for the file including path in tar archive
+ * @returns A FileItem
+ */
+export declare const createReadableItem: (path: string, reader: Readable, options?: CreateReadableItemOptions) => Promise<FileItem>;
+/**
+ * Create a FileItem from a local file path
+ * @param path - The path to the file in the tar archive
+ * @param filePath - The path to the file to read from real filesystem
+ * @param reflectStat - Whether to reflect optional stat of the file (mode, uid, gid, mtime. Default: 'exceptName')
+ * @param options - Metadata for the file including path in tar archive
+ * @returns A FileItem
+ */
+export declare const createReadFileItem: (path: string, filePath: string, reflectStat?: ReflectStats, options?: CreateItemOptions) => Promise<FileItem>;
+/**
+ * Store a readable stream to a file
+ * @param reader - The readable stream
+ * @param path - The path to the file to store the readable stream to
+ * @returns A promise that resolves when the stream is finished
+ */
+export declare const storeReaderToFile: (reader: Readable, path: string) => Promise<void>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,iBAAiB,EAAE,yBAAyB,EAAE,QAAQ,EAAE,aAAa,EAAE,YAAY,EAAE,0BAA0B,EAAE,MAAM,SAAS,CAAC;AAa1I;;;;;;;GAOG;AACH,eAAO,MAAM,mBAAmB,GAC9B,MAAM,MAAM,EACZ,cAAc,YAAY,EAC1B,UAAU,0BAA0B,KACnC,OAAO,CAAC,aAAa,CA2BvB,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,GAC7B,MAAM,MAAM,EACZ,QAAQ,QAAQ,EAChB,UAAU,yBAAyB,KAClC,OAAO,CAAC,QAAQ,CAuClB,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,kBAAkB,GAC7B,MAAM,MAAM,EACZ,UAAU,MAAM,EAChB,cAAc,YAAY,EAC1B,UAAU,iBAAiB,KAC1B,OAAO,CAAC,QAAQ,CAoBlB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAAI,QAAQ,QAAQ,EAAE,MAAM,MAAM,kBAO/D,CAAC"}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "tar-vern",
+  "version": "0.1.0",
+  "description": "Tape archiver library for Typescript",
+  "keywords": [
+    "typescript",
+    "tar",
+    "async",
+    "stream"
+  ],
+  "author": "Kouji Matsui (@kekyo@mi.kekyo.net)",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kekyo/tar-vern.git"
+  },
+  "homepage": "https://github.com/kekyo/tar-vern#readme",
+  "readme": "README_pack.md",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README_pack.md"
+  ],
+  "scripts": {
+    "build": "vite build",
+    "test": "npm run build && vitest run",
+    "dump": "npm run build && screw-up dump",
+    "pack": "npm run build && screw-up pack --pack-destination artifacts/"
+  },
+  "devDependencies": {
+    "@types/node": ">=20.0.0",
+    "screw-up": ">=0.9.1",
+    "typescript": ">=5.0.0",
+    "vite": ">=5.0.0",
+    "vite-plugin-dts": ">=3.0.0",
+    "vitest": ">=1.0.0"
+  }
+}