Compare commits
24 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| d557e4b4fe | |||
| 16ded5c3cf | |||
| a2bd049ebd | |||
| f95c5c9a15 | |||
| b55a3eb83f | |||
| fc8d994943 | |||
| f1daec6f44 | |||
| 6698a583e9 | |||
| bf52f01365 | |||
| 14adec5ba3 | |||
| fb2880c995 | |||
| 0e0ae7e42f | |||
| 1391dbddbc | |||
| 477736da82 | |||
| 26a67d9662 | |||
| 14771fab27 | |||
| b0ae383622 | |||
| 921f1cbb66 | |||
| a9b373f5f8 | |||
| f0d48cc763 | |||
| 255cc844ad | |||
| 50cc3fa8bf | |||
| 21b3870a7d | |||
| 023e1cdf29 |
293
changelog.md
Normal file
293
changelog.md
Normal file
@ -0,0 +1,293 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-01-07 - 11.1.0 - feat(SmartFile)
|
||||
Add rename functionality to SmartFile class
|
||||
|
||||
- Implemented a new method to rename a file within the SmartFile class.
|
||||
- The rename method updates the file path and optionally writes the renamed file to the disk.
|
||||
|
||||
## 2024-12-15 - 11.0.23 - fix(fs)
|
||||
Handle errors in toObjectSync method
|
||||
|
||||
- Added error handling in toObjectSync function to capture and provide more informative error messages.
|
||||
|
||||
## 2024-06-23 - 11.0.22 - fix(core)
|
||||
Update dependencies and changelog
|
||||
|
||||
- Updated @push.rocks/smartstream to ^3.0.44
|
||||
- Updated glob to ^10.4.2
|
||||
- Updated @types/node to ^20.14.8
|
||||
|
||||
## 2024-06-23 - 11.0.21 - fix(dependencies)
|
||||
Update dependencies to latest versions
|
||||
|
||||
- Updated @push.rocks/smartpromise to ^4.0.4
|
||||
- Updated @push.rocks/smartstream to ^3.0.44
|
||||
- Updated glob to ^10.4.2
|
||||
- Updated @types/node to ^20.14.8
|
||||
|
||||
## 2024-06-07 - 11.0.20 - Changelog
|
||||
11.0.20
|
||||
|
||||
## 2024-06-07 - 11.0.19 - fix(core): update
|
||||
11.0.19
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2024-06-07 - 11.0.18 - fix(core): update
|
||||
11.0.18
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2024-06-06 - 11.0.17 - fix(core): update
|
||||
11.0.17
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2024-06-06 - 11.0.16 - fix(core): update
|
||||
11.0.16
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2024-05-29 - 11.0.16 - update description
|
||||
11.0.16
|
||||
|
||||
- update description
|
||||
|
||||
## 2024-05-17 - 11.0.15 - fix(core): update
|
||||
11.0.15
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2024-04-14 - 11.0.14 - update tsconfig
|
||||
11.0.14
|
||||
|
||||
- update tsconfig
|
||||
|
||||
## 2024-04-12 - 11.0.13 - fix(core): update
|
||||
11.0.13
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2024-04-12 - 11.0.12 - fix(core): update
|
||||
11.0.12
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2024-04-12 - 11.0.11 - fix(core): update
|
||||
11.0.11
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2024-04-03 - 11.0.10 - fix(core): update
|
||||
11.0.10
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2024-04-03 - 11.0.9 - fix(core): update
|
||||
11.0.9
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2024-04-02 - 11.0.8 - fix(core): update
|
||||
11.0.8
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2024-04-02 - 11.0.7 - fix(core): update
|
||||
11.0.7
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2024-04-02 - 11.0.6 - fix(core): update
|
||||
11.0.6
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2024-04-01 - 11.0.5 - update npmextra.json
|
||||
11.0.5
|
||||
|
||||
- update npmextra.json: githost
|
||||
|
||||
## 2024-04-01 - 11.0.4 - fix(core): update
|
||||
11.0.4
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2023-11-24 - 11.0.3 - fix(core): update
|
||||
11.0.3
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2023-11-07 - 11.0.2 - fix(core): update
|
||||
11.0.2
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2023-11-07 - 11.0.1 - fix(core): update
|
||||
11.0.1
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2023-11-06 - 11.0.0 - fix(core): update
|
||||
11.0.0
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2023-11-06 - 10.0.40 - BREAKING CHANGE(core): update
|
||||
10.0.40
|
||||
|
||||
- BREAKING CHANGE(core): update
|
||||
|
||||
## 2023-11-04 - 10.0.39 - fix(core): update
|
||||
10.0.39
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2023-11-04 - 10.0.38 - fix(core): update
|
||||
10.0.38
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2023-11-04 - 10.0.37 - fix(core): update
|
||||
10.0.37
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2023-11-03 - 10.0.36 - fix(core): update
|
||||
10.0.36
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2023-11-03 - 10.0.35 - fix(core): update
|
||||
10.0.35
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2023-11-03 - 10.0.34 - fix(core): update
|
||||
10.0.34
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2023-11-03 - 10.0.33 - fix(core): update
|
||||
10.0.33
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2023-10-12 - 10.0.32 - fix(core): update
|
||||
10.0.32
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2023-09-22 - 10.0.31 - fix(core): update
|
||||
10.0.31
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2023-08-31 - 10.0.30 - fix(core): update
|
||||
10.0.30
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2023-08-23 - 10.0.29 - fix(core): update
|
||||
10.0.29
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2023-07-12 - 10.0.28 - fix(core): update
|
||||
10.0.28
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2023-07-10 - 10.0.27 - fix(core): update
|
||||
10.0.27
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2023-07-10 - 10.0.26 - fix(core): update
|
||||
10.0.26
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2023-07-08 - 10.0.25 - fix(core): update
|
||||
10.0.25
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2023-06-25 - 10.0.24 to 10.0.14 - Series of Fixes
|
||||
10.0.24 to 10.0.14
|
||||
|
||||
- Series of fixes in the core module
|
||||
|
||||
## 2023-01-09 - 10.0.13 to 10.0.6 - Series of Fixes
|
||||
10.0.13 to 10.0.6
|
||||
|
||||
- Series of fixes in the core module
|
||||
|
||||
## 2022-09-05 - 10.0.5 to 10.0.3 - Series of Fixes
|
||||
10.0.5 to 10.0.3
|
||||
|
||||
- Series of fixes in the core module
|
||||
|
||||
## 2022-06-07 - 10.0.2 to 10.0.1 - Series of Fixes
|
||||
10.0.2 to 10.0.1
|
||||
|
||||
- Series of fixes in the core module
|
||||
|
||||
## 2022-06-07 - 9.0.7 - BREAKING CHANGE(core): switch to esm
|
||||
9.0.7
|
||||
|
||||
- BREAKING CHANGE(core): switch to esm
|
||||
|
||||
## 2022-03-11 - 9.0.6 to 9.0.2 - Series of Fixes
|
||||
9.0.6 to 9.0.2
|
||||
|
||||
- Series of fixes in the core module
|
||||
|
||||
## 2021-12-01 - 9.0.1 - fix(core): update
|
||||
9.0.1
|
||||
|
||||
- fix(core): update
|
||||
|
||||
## 2021-12-01 - 9.0.0 - fix(absolute pathing)
|
||||
9.0.0
|
||||
|
||||
- add functions for easily getting absolute paths
|
||||
|
||||
## 2021-11-30 - 8.0.11 - BREAKING CHANGE(relative pathing)
|
||||
8.0.11
|
||||
|
||||
- improved relative pathing
|
||||
|
||||
## 2020-08-10 - 8.0.10 to 7.0.12 - Series of Fixes and Updates
|
||||
8.0.10 to 7.0.12
|
||||
|
||||
- Series of fixes in the core module
|
||||
- BREAKING CHANGE(Smartfile class): switch to a Buffer-only approach
|
||||
|
||||
## 2019-02-17 - 7.0.0 - fix(core): update dependencies
|
||||
7.0.0
|
||||
|
||||
- fix(core): update dependencies
|
||||
|
||||
## 2019-01-27 - 6.0.12 - BREAKING CHANGE(smartfile.fs.fileExists)
|
||||
6.0.12
|
||||
|
||||
- now returns a Promise<boolean>
|
||||
|
||||
## 2018-08-19 - 6.0.11 to 6.0.6 - Series of Fixes
|
||||
6.0.11 to 6.0.6
|
||||
|
||||
- Series of fixes in core and dependencies
|
||||
|
||||
## 2018-07-03 - 6.0.5 to 5.0.0 - Series of Fixes
|
||||
6.0.5 to 5.0.0
|
||||
|
||||
- Series of fixes in core and dependencies
|
||||
|
||||
## 2018-02-16 - 4.2.28 - BREAKING CHANGE(scope)
|
||||
4.2.28
|
||||
|
||||
- switch to pushrocks scope
|
||||
|
||||
|
||||
@ -10,22 +10,28 @@
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "smartfile",
|
||||
"description": "provides a robust suite of tools for managing files in Node.js using TypeScript.",
|
||||
"description": "Provides comprehensive tools for efficient file management in Node.js using TypeScript, including handling streams, virtual directories, and various file operations.",
|
||||
"npmPackagename": "@push.rocks/smartfile",
|
||||
"license": "MIT",
|
||||
"keywords": [
|
||||
"files management",
|
||||
"file management",
|
||||
"TypeScript",
|
||||
"Node.js",
|
||||
"read files",
|
||||
"write files",
|
||||
"copy files",
|
||||
"file operations",
|
||||
"file manipulation",
|
||||
"file streaming",
|
||||
"directories manipulation",
|
||||
"virtual file system",
|
||||
"virtual directory",
|
||||
"filesystem utilities",
|
||||
"ESM syntax",
|
||||
"memory-efficient streaming"
|
||||
"memory-efficient file handling",
|
||||
"custom file operations",
|
||||
"write files",
|
||||
"read files",
|
||||
"copy files",
|
||||
"delete files",
|
||||
"list directories",
|
||||
"handle large files",
|
||||
"virtual filesystems",
|
||||
"buffer operations"
|
||||
]
|
||||
}
|
||||
},
|
||||
|
||||
56
package.json
56
package.json
@ -1,8 +1,8 @@
|
||||
{
|
||||
"name": "@push.rocks/smartfile",
|
||||
"private": false,
|
||||
"version": "11.0.13",
|
||||
"description": "provides a robust suite of tools for managing files in Node.js using TypeScript.",
|
||||
"version": "11.1.0",
|
||||
"description": "Provides comprehensive tools for efficient file management in Node.js using TypeScript, including handling streams, virtual directories, and various file operations.",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
@ -13,52 +13,58 @@
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://gitlab.com/push.rocks/smartfile.git"
|
||||
"url": "https://code.foss.global/push.rocks/smartfile.git"
|
||||
},
|
||||
"keywords": [
|
||||
"files management",
|
||||
"file management",
|
||||
"TypeScript",
|
||||
"Node.js",
|
||||
"read files",
|
||||
"write files",
|
||||
"copy files",
|
||||
"file operations",
|
||||
"file manipulation",
|
||||
"file streaming",
|
||||
"directories manipulation",
|
||||
"virtual file system",
|
||||
"virtual directory",
|
||||
"filesystem utilities",
|
||||
"ESM syntax",
|
||||
"memory-efficient streaming"
|
||||
"memory-efficient file handling",
|
||||
"custom file operations",
|
||||
"write files",
|
||||
"read files",
|
||||
"copy files",
|
||||
"delete files",
|
||||
"list directories",
|
||||
"handle large files",
|
||||
"virtual filesystems",
|
||||
"buffer operations"
|
||||
],
|
||||
"author": "Lossless GmbH <hello@lossless.com> (https://lossless.com)",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://gitlab.com/push.rocks/smartfile/issues"
|
||||
},
|
||||
"homepage": "https://gitlab.com/push.rocks/smartfile#readme",
|
||||
"homepage": "https://code.foss.global/push.rocks/smartfile",
|
||||
"dependencies": {
|
||||
"@push.rocks/lik": "^6.0.14",
|
||||
"@push.rocks/lik": "^6.1.0",
|
||||
"@push.rocks/smartdelay": "^3.0.5",
|
||||
"@push.rocks/smartfile-interfaces": "^1.0.7",
|
||||
"@push.rocks/smarthash": "^3.0.4",
|
||||
"@push.rocks/smartjson": "^5.0.16",
|
||||
"@push.rocks/smartmime": "^1.0.5",
|
||||
"@push.rocks/smartpath": "^5.0.13",
|
||||
"@push.rocks/smartpromise": "^4.0.2",
|
||||
"@push.rocks/smartrequest": "^2.0.21",
|
||||
"@push.rocks/smartstream": "^3.0.34",
|
||||
"@push.rocks/smartjson": "^5.0.20",
|
||||
"@push.rocks/smartmime": "^2.0.4",
|
||||
"@push.rocks/smartpath": "^5.0.18",
|
||||
"@push.rocks/smartpromise": "^4.0.4",
|
||||
"@push.rocks/smartrequest": "^2.0.23",
|
||||
"@push.rocks/smartstream": "^3.2.5",
|
||||
"@types/fs-extra": "^11.0.4",
|
||||
"@types/glob": "^8.1.0",
|
||||
"@types/js-yaml": "^4.0.9",
|
||||
"fs-extra": "^11.2.0",
|
||||
"glob": "^10.3.12",
|
||||
"glob": "^11.0.0",
|
||||
"js-yaml": "^4.1.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@git.zone/tsbuild": "^2.1.72",
|
||||
"@git.zone/tsrun": "^1.2.46",
|
||||
"@git.zone/tstest": "^1.0.88",
|
||||
"@push.rocks/tapbundle": "^5.0.22",
|
||||
"@types/node": "^20.12.7"
|
||||
"@git.zone/tsbuild": "^2.2.0",
|
||||
"@git.zone/tsrun": "^1.3.3",
|
||||
"@git.zone/tstest": "^1.0.90",
|
||||
"@push.rocks/tapbundle": "^5.5.3",
|
||||
"@types/node": "^22.10.2"
|
||||
},
|
||||
"files": [
|
||||
"ts/**/*",
|
||||
|
||||
11147
pnpm-lock.yaml
generated
11147
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@ -0,0 +1 @@
|
||||
|
||||
322
readme.md
322
readme.md
@ -12,252 +12,214 @@ npm install @push.rocks/smartfile
|
||||
|
||||
## Usage
|
||||
|
||||
`@push.rocks/smartfile` offers a comprehensive set of utilities for handling files in Node.js projects using modern TypeScript and ESM syntax. It simplifies various file operations such as reading, writing, copying, and streaming files, as well as working with directories and virtual file systems.
|
||||
`@push.rocks/smartfile` offers extensive file management utilities, enabling seamless file processing with TypeScript in a Node.js environment. Below are detailed examples showcasing various features of the module.
|
||||
|
||||
### Key Features and Classes
|
||||
### Quick Start
|
||||
|
||||
- **`SmartFile`**: Facilitates reading from and writing to individual files, managing metadata.
|
||||
- **`StreamFile`**: Optimizes memory usage by enabling efficient file streaming.
|
||||
- **`VirtualDirectory`**: Allows manipulation of a group of files or directories as a virtual file system.
|
||||
|
||||
### Getting Started with ESM and TypeScript
|
||||
|
||||
First, ensure your project supports ESM syntax and TypeScript. Then, begin by importing the desired features from `@push.rocks/smartfile`:
|
||||
First, ensure you're working in an environment that supports ECMAScript modules (ESM) and TypeScript. Here’s how you’d generally import and use `@push.rocks/smartfile`:
|
||||
|
||||
```typescript
|
||||
import { SmartFile, StreamFile, VirtualDirectory, memory, fs as smartFs } from '@push.rocks/smartfile';
|
||||
import { SmartFile, StreamFile, VirtualDirectory, fs, memory, interpreter } from '@push.rocks/smartfile';
|
||||
```
|
||||
|
||||
### Reading and Writing Files
|
||||
### Working with `SmartFile`
|
||||
|
||||
#### Reading Files
|
||||
|
||||
Reading a JSON file:
|
||||
To read from a file and convert it to a `SmartFile` instance:
|
||||
|
||||
```typescript
|
||||
const myJsonFile: SmartFile = await SmartFile.fromFilePath('./data.json');
|
||||
const jsonData = JSON.parse(myJsonFile.contents.toString());
|
||||
console.log(jsonData);
|
||||
const myJsonSmartFile: SmartFile = await SmartFile.fromFilePath('./somePath/data.json');
|
||||
const jsonData = JSON.parse(myJsonSmartFile.contents.toString());
|
||||
console.log(jsonData); // Assuming the file contains JSON content
|
||||
```
|
||||
|
||||
#### Writing Files
|
||||
|
||||
Writing content to a file:
|
||||
To write data to a file through a `SmartFile`:
|
||||
|
||||
```typescript
|
||||
const filePath: string = './output.txt';
|
||||
const content: string = 'Hello, SmartFile!';
|
||||
const filePath: string = './output/outputData.json';
|
||||
const content: string = JSON.stringify({ key: 'value' });
|
||||
await memory.toFs(content, filePath);
|
||||
console.log('File saved successfully.');
|
||||
```
|
||||
|
||||
### Streaming Large Files
|
||||
### Streaming Large Files with `StreamFile`
|
||||
|
||||
For large files, `StreamFile` provides a memory-efficient streaming solution:
|
||||
When dealing with large files, you can use `StreamFile` to handle such files efficiently, minimizing memory usage:
|
||||
|
||||
```typescript
|
||||
import { createReadStream } from 'fs';
|
||||
const sourceStream = createReadStream('./large-video.mp4');
|
||||
const myStreamFile = await StreamFile.fromStream(sourceStream, 'large-video.mp4');
|
||||
await myStreamFile.writeToDir('./storage');
|
||||
console.log('Large file streamed to disk successfully.');
|
||||
const largeFile: StreamFile = await StreamFile.fromPath('./largeInput/largeFile.mp4');
|
||||
await largeFile.writeToDisk('./largeOutput/largeFileCopy.mp4');
|
||||
```
|
||||
|
||||
### Working with Virtual Directories
|
||||
|
||||
`VirtualDirectory` abstracts a collection of files allowing operations to be performed as if they were on disk:
|
||||
Handling multiple files as if they were part of a file system:
|
||||
|
||||
```typescript
|
||||
const virtualDir = new VirtualDirectory();
|
||||
virtualDir.addSmartfiles([smartFile1, smartFile2]); // Assuming these are SmartFile instances
|
||||
await virtualDir.saveToDisk('./virtual-output');
|
||||
console.log('Virtual directory saved to disk.');
|
||||
const virtualDir = await VirtualDirectory.fromFsDirPath('./data/inputDir');
|
||||
await virtualDir.saveToDisk('./data/outputDir');
|
||||
```
|
||||
|
||||
### Advanced File Operations
|
||||
### File System Operations
|
||||
|
||||
`@push.rocks/smartfile` simplifies complex file operations, including:
|
||||
- Copying directories and files
|
||||
- Removing files or directories
|
||||
- Listing files and directories with filters
|
||||
- Reading file content directly into JavaScript objects
|
||||
`@push.rocks/smartfile` provides a suite of utilities for common file system operations such as copying, deleting, and listing files or directories.
|
||||
|
||||
### Web File Handling
|
||||
#### Copying a File
|
||||
|
||||
Handling files from HTTP requests:
|
||||
`@push.rocks/smartfile` offers utilities to work with files from web sources, making it simpler to manage downloads and uploads.
|
||||
```typescript
|
||||
await fs.copy('./sourceFile.txt', './destinationFile.txt');
|
||||
```
|
||||
|
||||
### Comprehensive File Management
|
||||
#### Deleting a Directory
|
||||
|
||||
Whether you're dealing with local files, directories, or files over the internet, `@push.rocks/smartfile` provides a comprehensive set of tools to streamline your workflow and reduce the complexity of file management in your Node.js projects.
|
||||
```typescript
|
||||
await fs.remove('./directoryToDelete');
|
||||
```
|
||||
|
||||
## API Reference
|
||||
#### Listing Files in a Directory
|
||||
|
||||
### `SmartFile` Class
|
||||
```typescript
|
||||
const fileList: string[] = await fs.listFiles('./someDirectory');
|
||||
console.log(fileList);
|
||||
```
|
||||
|
||||
#### Static Methods
|
||||
### Advanced File Management
|
||||
|
||||
- `SmartFile.fromFilePath(filePath: string, baseArg?: string): Promise<SmartFile>`
|
||||
- Creates a `SmartFile` instance from a file path.
|
||||
- `SmartFile.fromBuffer(filePath: string, contentBufferArg: Buffer, baseArg?: string): Promise<SmartFile>`
|
||||
- Creates a `SmartFile` instance from a `Buffer`.
|
||||
- `SmartFile.fromString(filePath: string, contentStringArg: string, encodingArg: 'utf8' | 'binary', baseArg?: string): Promise<SmartFile>`
|
||||
- Creates a `SmartFile` instance from a string.
|
||||
- `SmartFile.fromFoldedJson(foldedJsonArg: string): Promise<SmartFile>`
|
||||
- Creates a `SmartFile` instance from a folded JSON string.
|
||||
- `SmartFile.fromStream(stream: Readable, filePath: string, baseArg?: string): Promise<SmartFile>`
|
||||
- Creates a `SmartFile` instance from a `Readable` stream.
|
||||
- `SmartFile.fromUrl(urlArg: string): Promise<SmartFile>`
|
||||
- Creates a `SmartFile` instance from a URL.
|
||||
For specialized file operations, such as editing the contents of a file or streaming files from URLs, `@push.rocks/smartfile` includes advanced management features.
|
||||
|
||||
#### Instance Properties
|
||||
#### Editing a File’s Contents
|
||||
|
||||
- `path: string`
|
||||
- The relative path of the file.
|
||||
- `parsedPath: path.ParsedPath`
|
||||
- A parsed path object.
|
||||
- `absolutePath: string`
|
||||
- The absolute path of the file.
|
||||
- `absoluteParsedPath: path.ParsedPath`
|
||||
- A parsed absolute path object.
|
||||
- `contentBuffer: Buffer`
|
||||
- The content of the file as a `Buffer`.
|
||||
- `base: string`
|
||||
- The current working directory of the file.
|
||||
- `sync: boolean`
|
||||
- Indicates whether the file is synced with the disk.
|
||||
```typescript
|
||||
const smartFileToEdit: SmartFile = await SmartFile.fromFilePath('./editableFile.txt');
|
||||
await smartFileToEdit.editContentAsString(async (content) => content.replace(/originalText/g, 'newText'));
|
||||
await smartFileToEdit.write();
|
||||
```
|
||||
|
||||
#### Instance Methods
|
||||
#### Streaming a File from a URL
|
||||
|
||||
- `setContentsFromString(contentString: string, encodingArg?: 'utf8' | 'binary'): void`
|
||||
- Sets the contents of the file from a string.
|
||||
- `write(): Promise<void>`
|
||||
- Writes the file to disk at its original location.
|
||||
- `writeToDiskAtPath(filePathArg: string): Promise<void>`
|
||||
- Writes the file to the specified path on disk.
|
||||
- `writeToDir(dirPathArg: string): Promise<string>`
|
||||
- Writes the file to a directory combined with the relative path portion.
|
||||
- `read(): Promise<void>`
|
||||
- Reads the file from disk.
|
||||
- `delete(): Promise<void>`
|
||||
- Deletes the file from disk at its original location.
|
||||
- `getHash(typeArg?: 'path' | 'content' | 'all'): Promise<string>`
|
||||
- Returns a hash of the file based on the specified type.
|
||||
- `updateFileName(fileNameArg: string): void`
|
||||
- Updates the file name of the `SmartFile` instance.
|
||||
- `editContentAsString(editFuncArg: (fileStringArg: string) => Promise<string>): Promise<void>`
|
||||
- Edits the content of the file as a string using the provided edit function.
|
||||
- `getStream(): Readable`
|
||||
- Returns a `Readable` stream from the file's content buffer.
|
||||
```typescript
|
||||
const streamedFile: StreamFile = await StreamFile.fromUrl('https://example.com/file.pdf');
|
||||
await streamedFile.writeToDisk('./downloadedFiles/file.pdf');
|
||||
```
|
||||
|
||||
### `StreamFile` Class
|
||||
### Working with File Buffers and Streams
|
||||
|
||||
#### Static Methods
|
||||
`@push.rocks/smartfile` allows you to easily work with files using Buffers and Streams, facilitating operations like file transformations, uploads, and downloads.
|
||||
|
||||
- `StreamFile.fromPath(filePath: string): Promise<StreamFile>`
|
||||
- Creates a `StreamFile` instance from a file path.
|
||||
- `StreamFile.fromUrl(url: string): Promise<StreamFile>`
|
||||
- Creates a `StreamFile` instance from a URL.
|
||||
- `StreamFile.fromBuffer(buffer: Buffer, relativeFilePath?: string): StreamFile`
|
||||
- Creates a `StreamFile` instance from a `Buffer`.
|
||||
- `StreamFile.fromStream(stream: Readable, relativeFilePath?: string, multiUse?: boolean): StreamFile`
|
||||
- Creates a `StreamFile` instance from a `Readable` stream.
|
||||
#### Creating a SmartFile from a Buffer
|
||||
|
||||
#### Instance Properties
|
||||
```typescript
|
||||
const buffer: Buffer = Buffer.from('Sample data');
|
||||
const bufferSmartFile: SmartFile = await SmartFile.fromBuffer('./bufferFile.txt', buffer);
|
||||
await bufferSmartFile.write();
|
||||
```
|
||||
|
||||
- `relativeFilePath?: string`
|
||||
- The relative file path of the `StreamFile`.
|
||||
- `multiUse: boolean`
|
||||
- Indicates whether the `StreamFile` can be used multiple times.
|
||||
- `used: boolean`
|
||||
- Indicates whether the `StreamFile` has been used.
|
||||
### Using `VirtualDirectory` for Complex File Management
|
||||
|
||||
#### Instance Methods
|
||||
`VirtualDirectory` simplifies the management of multiple files that are otherwise scattered across different directories or created at runtime.
|
||||
|
||||
- `createReadStream(): Promise<Readable>`
|
||||
- Creates a new `Readable` stream from the source.
|
||||
- `writeToDisk(filePathArg: string): Promise<void>`
|
||||
- Writes the stream to the disk at the specified path.
|
||||
- `writeToDir(dirPathArg: string): Promise<void>`
|
||||
- Writes the stream to a directory combined with the relative path portion.
|
||||
- `getContentAsBuffer(): Promise<Buffer>`
|
||||
- Returns the content of the `StreamFile` as a `Buffer`.
|
||||
- `getContentAsString(formatArg?: 'utf8' | 'binary'): Promise<string>`
|
||||
- Returns the content of the `StreamFile` as a string.
|
||||
#### Creating a `VirtualDirectory`
|
||||
|
||||
### `VirtualDirectory` Class
|
||||
To create a `VirtualDirectory` from an existing file directory:
|
||||
|
||||
#### Static Methods
|
||||
```typescript
|
||||
const virtualDirectory = await VirtualDirectory.fromFsDirPath('./someDirectory');
|
||||
```
|
||||
|
||||
- `VirtualDirectory.fromFsDirPath(pathArg: string): Promise<VirtualDirectory>`
|
||||
- Creates a `VirtualDirectory` instance from a file system directory path.
|
||||
- `VirtualDirectory.fromVirtualDirTransferableObject(virtualDirTransferableObjectArg: VirtualDirTransferableObject): Promise<VirtualDirectory>`
|
||||
- Creates a `VirtualDirectory` instance from a `VirtualDirTransferableObject`.
|
||||
#### Adding More Files
|
||||
|
||||
#### Instance Properties
|
||||
You can add more `SmartFile` instances to your `VirtualDirectory`:
|
||||
|
||||
- `smartfileArray: SmartFile[]`
|
||||
- An array of `SmartFile` instances in the `VirtualDirectory`.
|
||||
```typescript
|
||||
const additionalFiles = [
|
||||
await SmartFile.fromFilePath('./anotherDirectory/file1.txt'),
|
||||
await SmartFile.fromFilePath('./anotherDirectory/file2.txt')
|
||||
];
|
||||
virtualDirectory.addSmartfiles(additionalFiles);
|
||||
```
|
||||
|
||||
#### Instance Methods
|
||||
#### Saving `VirtualDirectory` to Disk
|
||||
|
||||
- `addSmartfiles(smartfileArrayArg: SmartFile[]): void`
|
||||
- Adds an array of `SmartFile` instances to the `VirtualDirectory`.
|
||||
- `getFileByPath(pathArg: string): Promise<SmartFile | undefined>`
|
||||
- Retrieves a `SmartFile` instance from the `VirtualDirectory` by its path.
|
||||
- `toVirtualDirTransferableObject(): Promise<VirtualDirTransferableObject>`
|
||||
- Converts the `VirtualDirectory` to a `VirtualDirTransferableObject`.
|
||||
- `saveToDisk(dirArg: string): Promise<void>`
|
||||
- Saves the `VirtualDirectory` to the disk at the specified directory.
|
||||
- `shiftToSubdirectory(subDir: string): Promise<VirtualDirectory>`
|
||||
- Shifts the `VirtualDirectory` to a subdirectory.
|
||||
- `addVirtualDirectory(virtualDir: VirtualDirectory, newRoot: string): Promise<void>`
|
||||
- Adds another `VirtualDirectory` to the current `VirtualDirectory` with a new root path.
|
||||
Save your entire `VirtualDirectory` to disk:
|
||||
|
||||
### `fs` Module
|
||||
```typescript
|
||||
await virtualDirectory.saveToDisk('./outputDirectory');
|
||||
```
|
||||
|
||||
The `fs` module provides various file system utility functions. Some notable functions include:
|
||||
### Utilizing StreamFile for Efficient File Handling
|
||||
|
||||
- `fileExistsSync(filePath: string): boolean`
|
||||
- Checks if a file exists synchronously.
|
||||
- `fileExists(filePath: string): Promise<boolean>`
|
||||
- Checks if a file exists asynchronously.
|
||||
- `listFoldersSync(pathArg: string, regexFilter?: RegExp): string[]`
|
||||
- Lists folders in a directory synchronously.
|
||||
- `listFolders(pathArg: string, regexFilter?: RegExp): Promise<string[]>`
|
||||
- Lists folders in a directory asynchronously.
|
||||
- `listFilesSync(pathArg: string, regexFilter?: RegExp): string[]`
|
||||
- Lists files in a directory synchronously.
|
||||
- `listFiles(pathArg: string, regexFilter?: RegExp): Promise<string[]>`
|
||||
- Lists files in a directory asynchronously.
|
||||
- `listFileTree(dirPathArg: string, miniMatchFilter: string, absolutePathsBool?: boolean): Promise<string[]>`
|
||||
- Lists a file tree using a minimatch filter.
|
||||
- `waitForFileToBeReady(filePathArg: string): Promise<void>`
|
||||
- Waits for a file to be ready (exists and is not empty).
|
||||
- `toFs(filePathArg: string, fileContentArg: string | Buffer | SmartFile | StreamFile, optionsArg?: { respectRelative?: boolean }): Promise<void>`
|
||||
- Writes a string, `Buffer`, `SmartFile`, or `StreamFile` to the file system.
|
||||
Using `StreamFile` can be especially beneficial for large files or when performing streaming operations.
|
||||
|
||||
### `memory` Module
|
||||
#### Streaming from a URL
|
||||
|
||||
The `memory` module provides utility functions for working with files in memory. Some notable functions include:
|
||||
`StreamFile` provides capabilities to stream files directly from URLs, making it easier to work with remote content.
|
||||
|
||||
- `toObject(fileStringArg: string, fileTypeArg: string): any`
|
||||
- Converts a file string to an object based on the file type.
|
||||
- `toFs(fileContentArg: string | Buffer | SmartFile | StreamFile, filePathArg: string, optionsArg?: IToFsOptions): Promise<void>`
|
||||
- Writes a string, `Buffer`, `SmartFile`, or `StreamFile` to the file system.
|
||||
- `toFsSync(fileArg: string, filePathArg: string): void`
|
||||
- Writes a string to the file system synchronously.
|
||||
- `smartfileArrayToFs(smartfileArrayArg: SmartFile[], dirArg: string): Promise<void>`
|
||||
- Writes an array of `SmartFile` instances to the file system.
|
||||
```typescript
|
||||
const urlStreamFile: StreamFile = await StreamFile.fromUrl('https://example.com/largefile.zip');
|
||||
await urlStreamFile.writeToDisk('./downloadedFiles/largefile.zip');
|
||||
```
|
||||
|
||||
### `interpreter` Module
|
||||
### Combining Buffer and Stream Approaches
|
||||
|
||||
The `interpreter` module provides utility functions for interpreting file types and contents. Some notable functions include:
|
||||
Create `StreamFile` from a buffer for efficient, multi-use streams.
|
||||
|
||||
- `filetype(pathArg: string): string`
|
||||
- Determines the file type based on the file path.
|
||||
- `objectFile(fileStringArg: string, fileTypeArg: any): any`
|
||||
- Converts a file string to an object based on the file type.
|
||||
```typescript
|
||||
const buffer = Buffer.from('Streaming buffer content');
|
||||
const bufferStreamFile = StreamFile.fromBuffer(buffer, 'bufferBasedStream.txt');
|
||||
await bufferStreamFile.writeToDisk('./streams/bufferBasedStream.txt');
|
||||
```
|
||||
|
||||
### Read and Write Operations with StreamFile
|
||||
|
||||
Perform read and write operations efficiently using `StreamFile`.
|
||||
|
||||
```typescript
|
||||
const fileStream = await StreamFile.fromPath('./inputData/largeFile.data');
|
||||
await fileStream.writeToDisk('./outputData/largeFileCopy.data');
|
||||
```
|
||||
|
||||
Check for completeness of your read and write operations, ensuring the integrity of file content.
|
||||
|
||||
```typescript
|
||||
const readBuffer = await fileStream.getContentAsBuffer();
|
||||
console.log(readBuffer.toString());
|
||||
```
|
||||
|
||||
### Ensuring File Readiness for Streaming
|
||||
|
||||
Ensure a file is ready for streaming or create a custom readable stream incorporating data transformation.
|
||||
|
||||
```typescript
|
||||
const smartReadStream = new SmartReadStream('./incomingData/sample.data');
|
||||
smartReadStream.on('data', (chunk) => {
|
||||
console.log('New Data Chunk:', chunk.toString());
|
||||
});
|
||||
```
|
||||
|
||||
### File Transformation with SmartReadStream
|
||||
|
||||
Perform transformations on the stream of data while reading:
|
||||
|
||||
```typescript
|
||||
smartReadStream.on('data', (chunk) => {
|
||||
// Perform some transformation
|
||||
const transformedChunk = chunk.toString().toUpperCase();
|
||||
console.log('Transformed Data Chunk:', transformedChunk);
|
||||
});
|
||||
```
|
||||
|
||||
### Streaming with SmartReadStream
|
||||
|
||||
Stream data from a `SmartReadStream` to a file efficiently managing large datasets.
|
||||
|
||||
```typescript
|
||||
const transformedWriteStream = fs.createWriteStream('./processedData/transformed.data');
|
||||
smartReadStream.pipe(transformedWriteStream);
|
||||
```
|
||||
|
||||
`@push.rocks/smartfile` significantly simplifies the handling of complex file operations in Node.js projects, making these tasks straightforward while maintaining efficiency and ease of use. Explore and leverage these features to enhance your project's file management capabilities.
|
||||
|
||||
## License and Legal Information
|
||||
|
||||
@ -276,4 +238,4 @@ Registered at District court Bremen HRB 35230 HB, Germany
|
||||
|
||||
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||
|
||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@push.rocks/smartfile',
|
||||
version: '11.0.13',
|
||||
description: 'provides a robust suite of tools for managing files in Node.js using TypeScript.'
|
||||
version: '11.1.0',
|
||||
description: 'Provides comprehensive tools for efficient file management in Node.js using TypeScript, including handling streams, virtual directories, and various file operations.'
|
||||
}
|
||||
|
||||
@ -91,7 +91,7 @@ export class SmartFile extends plugins.smartjson.Smartjson {
|
||||
});
|
||||
}
|
||||
|
||||
public static async fromUrl (urlArg: string) {
|
||||
public static async fromUrl(urlArg: string) {
|
||||
const response = await plugins.smartrequest.getBinary(urlArg);
|
||||
const smartfile = await SmartFile.fromBuffer(urlArg, response.body);
|
||||
return smartfile;
|
||||
@ -212,6 +212,43 @@ export class SmartFile extends plugins.smartjson.Smartjson {
|
||||
await fs.remove(plugins.path.join(this.base, this.path));
|
||||
}
|
||||
|
||||
/**
|
||||
* Renames the file to the specified new name.
|
||||
* - Updates the `path` property with the new name.
|
||||
* - Writes the file to the new location if it exists on disk.
|
||||
* @param newName The new name of the file (including extension if applicable).
|
||||
* @param writeToDisk (optional) If true, also renames the file on the disk.
|
||||
* @returns The updated file path after renaming.
|
||||
*/
|
||||
public async rename(newName: string, writeToDisk: boolean = false): Promise<string> {
|
||||
// Validate the new name
|
||||
if (!newName || typeof newName !== 'string') {
|
||||
throw new Error('Invalid new name provided.');
|
||||
}
|
||||
|
||||
// Extract the directory path
|
||||
const oldFilePath = this.path;
|
||||
const dirPath = plugins.path.dirname(this.path);
|
||||
|
||||
// Create the new file path
|
||||
const newFilePath = plugins.path.join(dirPath, newName);
|
||||
|
||||
// Update the `path` property
|
||||
this.path = newFilePath;
|
||||
|
||||
// Optionally write the renamed file to disk
|
||||
if (writeToDisk) {
|
||||
const oldAbsolutePath = plugins.smartpath.transform.makeAbsolute(oldFilePath, this.base);
|
||||
const newAbsolutePath = plugins.smartpath.transform.makeAbsolute(newFilePath, this.base);
|
||||
|
||||
// Rename the file on disk
|
||||
await plugins.fsExtra.rename(oldAbsolutePath, newAbsolutePath);
|
||||
}
|
||||
|
||||
// Return the new path
|
||||
return this.path;
|
||||
}
|
||||
|
||||
// -----------------------------------------------
|
||||
// vinyl compatibility
|
||||
// -----------------------------------------------
|
||||
@ -306,4 +343,11 @@ export class SmartFile extends plugins.smartjson.Smartjson {
|
||||
stream.push(null); // Push null to signify the end of the stream (EOF)
|
||||
return stream;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the size of the file in bytes
|
||||
*/
|
||||
public async getSize(): Promise<number> {
|
||||
return this.contentBuffer.length;
|
||||
}
|
||||
}
|
||||
|
||||
@ -10,26 +10,16 @@ type TStreamSource = (streamFile: StreamFile) => Promise<Readable>;
|
||||
* It allows creating streams from a file path, a URL, or a buffer.
|
||||
*/
|
||||
export class StreamFile {
|
||||
// INSTANCE
|
||||
relativeFilePath?: string;
|
||||
private streamSource: TStreamSource;
|
||||
|
||||
// enable stream based multi use
|
||||
private cachedStreamBuffer?: Buffer;
|
||||
public multiUse: boolean;
|
||||
public used: boolean = false;
|
||||
|
||||
private constructor(streamSource: TStreamSource, relativeFilePath?: string) {
|
||||
this.streamSource = streamSource;
|
||||
this.relativeFilePath = relativeFilePath;
|
||||
}
|
||||
|
||||
// STATIC
|
||||
|
||||
public static async fromPath(filePath: string): Promise<StreamFile> {
|
||||
const streamSource: TStreamSource = async (stremFileArg) => smartfileFsStream.createReadStream(filePath);
|
||||
const streamSource: TStreamSource = async (streamFileArg) => smartfileFsStream.createReadStream(filePath);
|
||||
const streamFile = new StreamFile(streamSource, filePath);
|
||||
streamFile.multiUse = true;
|
||||
streamFile.byteLengthComputeFunction = async () => {
|
||||
const stats = await smartfileFs.stat(filePath);
|
||||
return stats.size;
|
||||
}
|
||||
return streamFile;
|
||||
}
|
||||
|
||||
@ -37,6 +27,10 @@ export class StreamFile {
|
||||
const streamSource: TStreamSource = async (streamFileArg) => plugins.smartrequest.getStream(url); // Replace with actual plugin method
|
||||
const streamFile = new StreamFile(streamSource);
|
||||
streamFile.multiUse = true;
|
||||
streamFile.byteLengthComputeFunction = async () => {
|
||||
const response = await plugins.smartrequest.getBinary(url); // TODO: switch to future .getBinaryByteLength()
|
||||
return response.body.length;
|
||||
}
|
||||
return streamFile;
|
||||
}
|
||||
|
||||
@ -49,6 +43,7 @@ export class StreamFile {
|
||||
};
|
||||
const streamFile = new StreamFile(streamSource, relativeFilePath);
|
||||
streamFile.multiUse = true;
|
||||
streamFile.byteLengthComputeFunction = async () => buffer.length;
|
||||
return streamFile;
|
||||
}
|
||||
|
||||
@ -91,6 +86,22 @@ export class StreamFile {
|
||||
return streamFile;
|
||||
}
|
||||
|
||||
|
||||
// INSTANCE
|
||||
relativeFilePath?: string;
|
||||
private streamSource: TStreamSource;
|
||||
|
||||
// enable stream based multi use
|
||||
private cachedStreamBuffer?: Buffer;
|
||||
public multiUse: boolean;
|
||||
public used: boolean = false;
|
||||
public byteLengthComputeFunction: () => Promise<number>;
|
||||
|
||||
private constructor(streamSource: TStreamSource, relativeFilePath?: string) {
|
||||
this.streamSource = streamSource;
|
||||
this.relativeFilePath = relativeFilePath;
|
||||
}
|
||||
|
||||
// METHODS
|
||||
|
||||
private checkMultiUse() {
|
||||
@ -149,4 +160,15 @@ export class StreamFile {
|
||||
const contentBuffer = await this.getContentAsBuffer();
|
||||
return contentBuffer.toString(formatArg);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the size of the file content in bytes.
|
||||
*/
|
||||
public async getSize(): Promise<number> {
|
||||
if (this.byteLengthComputeFunction) {
|
||||
return this.byteLengthComputeFunction();
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
}
|
||||
21
ts/fs.ts
21
ts/fs.ts
@ -190,7 +190,8 @@ export const removeManySync = (filePathArrayArg: string[]): void => {
|
||||
===============================================================*/
|
||||
|
||||
/**
|
||||
*
|
||||
* reads a file content to an object
|
||||
* good for JSON, YAML, TOML, etc.
|
||||
* @param filePathArg
|
||||
* @param fileTypeArg
|
||||
* @returns {any}
|
||||
@ -199,14 +200,19 @@ export const toObjectSync = (filePathArg, fileTypeArg?) => {
|
||||
const fileString = plugins.fsExtra.readFileSync(filePathArg, 'utf8');
|
||||
let fileType;
|
||||
fileTypeArg ? (fileType = fileTypeArg) : (fileType = interpreter.filetype(filePathArg));
|
||||
return interpreter.objectFile(fileString, fileType);
|
||||
try {
|
||||
return interpreter.objectFile(fileString, fileType);
|
||||
} catch (err) {
|
||||
err.message = `Failed to read file at ${filePathArg}` + err.message;
|
||||
throw err;
|
||||
};
|
||||
};
|
||||
|
||||
/**
|
||||
* reads a file content to a String
|
||||
*/
|
||||
export const toStringSync = (filePath: string): string => {
|
||||
const encoding = plugins.smartmime.getEncoding(filePath);
|
||||
const encoding = plugins.smartmime.getEncodingForPathSync(filePath);
|
||||
let fileString: string | Buffer = plugins.fsExtra.readFileSync(filePath, encoding);
|
||||
if (Buffer.isBuffer(fileString)) {
|
||||
fileString = fileString.toString('binary');
|
||||
@ -447,8 +453,8 @@ export const waitForFileToBeReady = (filePathArg: string): Promise<void> => {
|
||||
* @param fileBaseArg
|
||||
*/
|
||||
export let toFs = async (
|
||||
filePathArg: string,
|
||||
fileContentArg: string | Buffer | SmartFile | StreamFile,
|
||||
filePathArg: string,
|
||||
optionsArg: {
|
||||
respectRelative?: boolean;
|
||||
} = {}
|
||||
@ -485,7 +491,6 @@ export let toFs = async (
|
||||
return await done.promise;
|
||||
};
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
export const stat = async (filePathArg: string) => {
|
||||
return plugins.fsPromises.stat(filePathArg);
|
||||
}
|
||||
|
||||
@ -1,9 +1,10 @@
|
||||
// node native scope
|
||||
import * as fs from 'fs';
|
||||
import * as fsPromises from 'fs/promises';
|
||||
import * as path from 'path';
|
||||
import * as stream from 'stream';
|
||||
|
||||
export { fs, path, stream };
|
||||
export { fs, fsPromises, path, stream };
|
||||
|
||||
// @pushrocks scope
|
||||
import * as lik from '@push.rocks/lik';
|
||||
|
||||
Reference in New Issue
Block a user