@guanghechen/filepart 2.0.0 → 2.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present guanghechen (https://github.com/guanghechen)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -49,7 +49,8 @@
 </header>
 <br/>
 
-File helper utilities for splitting files and merging streams.
+File helper utilities for calculating file part ranges and generating part names. Useful for
+splitting large files into smaller chunks.
 
 ## Install
 
@@ -67,5 +68,77 @@ File helper utilities for splitting files and merging streams.
 
 ## Usage
 
+### Calculate File Parts by Size
+
+Split a file into parts of a specific size:
+
+```typescript
+import { calcFilePartItemsBySize } from '@guanghechen/filepart'
+
+const fileSize = 1000 // bytes
+const partSize = 300  // bytes per part
+
+const parts = [...calcFilePartItemsBySize(fileSize, partSize)]
+// Result:
+// [
+//   { sid: 1, start: 0, end: 300 },
+//   { sid: 2, start: 300, end: 600 },
+//   { sid: 3, start: 600, end: 900 },
+//   { sid: 4, start: 900, end: 1000 }
+// ]
+```
+
+### Calculate File Parts by Count
+
+Split a file into a specific number of parts:
+
+```typescript
+import { calcFilePartItemsByCount } from '@guanghechen/filepart'
+
+const fileSize = 1000 // bytes
+const partCount = 3   // number of parts
+
+const parts = [...calcFilePartItemsByCount(fileSize, partCount)]
+// Result:
+// [
+//   { sid: 1, start: 0, end: 334 },
+//   { sid: 2, start: 334, end: 668 },
+//   { sid: 3, start: 668, end: 1000 }
+// ]
+```
+
+### Generate Part Names
+
+Generate file part names with padded sequence numbers:
+
+```typescript
+import { calcFilePartNames, calcFilePartNamesByCount } from '@guanghechen/filepart'
+
+// From existing parts
+const parts = [{ sid: 1 }, { sid: 2 }, { sid: 3 }]
+const names = [...calcFilePartNames(parts, '.part')]
+// Result: ['.part1', '.part2', '.part3']
+
+// For 14 parts (with zero-padding)
+const names14 = [...calcFilePartNamesByCount(14, '.part')]
+// Result: ['.part01', '.part02', ... '.part14']
+
+// Single part returns empty string (no suffix needed)
+const singlePart = [...calcFilePartNamesByCount(1, '.part')]
+// Result: ['']
+```
+
+### Constants
+
+```typescript
+import { DEFAULT_FILEPART_CODE_PREFIX } from '@guanghechen/filepart'
+
+console.log(DEFAULT_FILEPART_CODE_PREFIX) // '.ghc-part'
+```
+
+## Reference
+
+- [homepage][homepage]
+
 [homepage]:
-  https://github.com/guanghechen/sora/tree/@guanghechen/filepart@2.0.0/packages/filepart#readme
+  https://github.com/guanghechen/sora/tree/@guanghechen/filepart@2.0.0/packages/filepart#readme

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guanghechen/filepart",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "File helper",
   "author": {
     "name": "guanghechen",
@@ -8,10 +8,10 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/filepart@1.0.4",
+    "url": "https://github.com/guanghechen/sora/tree/@guanghechen/filepart@2.0.0",
     "directory": "packages/filepart"
   },
-  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/filepart@1.0.4/packages/filepart#readme",
+  "homepage": "https://github.com/guanghechen/sora/tree/@guanghechen/filepart@2.0.0/packages/filepart#readme",
   "keywords": [
     "file helper",
     "split file",
@@ -20,10 +20,10 @@
   "type": "module",
   "exports": {
     ".": {
+      "types": "./lib/types/index.d.ts",
       "source": "./src/index.ts",
       "import": "./lib/esm/index.mjs",
-      "require": "./lib/cjs/index.cjs",
-      "types": "./lib/types/index.d.ts"
+      "require": "./lib/cjs/index.cjs"
     }
   },
   "source": "./src/index.ts",
@@ -31,13 +31,6 @@
   "module": "./lib/esm/index.mjs",
   "types": "./lib/types/index.d.ts",
   "license": "MIT",
-  "scripts": {
-    "build": "rollup -c ../../rollup.config.mjs",
-    "clean": "rimraf lib",
-    "test": "vitest run --config ../../vitest.config.ts",
-    "test:coverage": "vitest run --config ../../vitest.config.ts --coverage",
-    "test:update": "vitest run --config ../../vitest.config.ts -u"
-  },
   "files": [
     "lib/",
     "!lib/**/*.map",
@@ -47,7 +40,13 @@
     "README.md"
   ],
   "dependencies": {
-    "@guanghechen/invariant": "^7.0.0"
+    "@guanghechen/invariant": "^7.0.1"
   },
-  "gitHead": "12990a720b31d50d217e2e17a6191256dc94eda6"
-}
+  "scripts": {
+    "build": "rollup -c ../../rollup.config.mjs",
+    "clean": "rimraf lib",
+    "test": "vitest run --config ../../vitest.config.ts",
+    "test:coverage": "vitest run --config ../../vitest.config.ts --coverage",
+    "test:update": "vitest run --config ../../vitest.config.ts -u"
+  }
+}