Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nikitakozlovjr/file-manager
This file manager module provides functions for quickly working with files thanks to asynchronous work with them.
https://github.com/nikitakozlovjr/file-manager
Last synced: about 20 hours ago
JSON representation
This file manager module provides functions for quickly working with files thanks to asynchronous work with them.
- Host: GitHub
- URL: https://github.com/nikitakozlovjr/file-manager
- Owner: nikitakozlovjr
- Created: 2023-11-17T09:06:38.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2023-12-05T12:31:23.000Z (12 months ago)
- Last Synced: 2023-12-05T22:44:42.044Z (12 months ago)
- Language: JavaScript
- Homepage:
- Size: 253 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://codeclimate.com/github/nikitakozlovjr/File-Manager/maintainability)
# File-Manager
### Description
____
This file manager module provides functions for quickly working with files thanks to asynchronous work with them. The file manager includes the following features:
- print
- write
- move
- getDirectorySize
- watch
To start working with this module, clone the repository `git clone` and run the command
```
make install
npm link
```
Perhaps the npm link command may require the permission of the sudo administrator
## Module getDirectorySize
### Description
___
This function calculates the size of the passed directory. The function only counts the size of files nested in it, without taking into account other directories nested in it.
### Startup instructions
___
The function **getDirectorySize** is an executable file, so to use it you just need to issue the following command and pass as an argument the relative path to the directory whose size you want to know
```
getDirectorySize __fixtures__
```
### Example of work
[](https://asciinema.org/a/eX08BXJ3EjCY5YLGseUPG8dZV)
## Module watch
### Description
___
This function monitors a file and tracks changes in it at a specified time interval. If changes occur, informs the user and calculates changes in file size
### Startup instructions
___
The function **watch** provides an executable file that takes three arguments in the specific sequence shown below. Accepted Arguments
- path to the file
- time interval of checks
- observation operating time
```
watch __fixtures__/file1.txt 500 10000
```
### Example of work
[](https://asciinema.org/a/fU0IKKB3Jk9oElv0cvqyuWirP)
## Module print
### Description
___
This function asynchronously reads the transferred file and displays the contents of the file to the console.
### Startup instructions
___
The function **print** provides an executable file, which will take a single argument: path to file
```
print __fixtures__/file2.txt
```
### Example of work
[](https://asciinema.org/a/PcoP4IEaPqzDGCyxnPVDwT4S1)
## Module move
### Description
___
:warning: **Be careful when using this module**: This module can mutate the file system (delete a file)!
This function transfers data from the first transferred file to another file, and then deletes the first transferred file (from where the data is transferred)
### Startup instructions
___
The function **move** takes two input arguments in the form of relative paths to files
- output file
- input file
```
move __fixtures__/file1.txt __fixtures__/file2.txt
```
### Example of work
[](https://asciinema.org/a/5zU8tC9DTRmKEvu2KTFIDquaz)
## Module write
### Description
___
:warning: **Be careful when using this module**: This module can mutate the file system (changing data or creating new files)!
This function writes the transferred data to a file. If the file does not exist, it is created with the files already transferred.
### Startup instructions
___
The function **write** takes two arguments as input in strict sequence
- relative path to the file
- data
```
write __fixtures__/file1.txt Hello, world!
```
### Example of work
[](https://asciinema.org/a/uoqa3uWCZeFdAcyumog30SHZ6)
## Module write
### Description
___
:warning: **Be careful when using this module**: This module can mutate the file system (changing file data)!
This module reverses (rewrites in reverse order) the data of the transferred file
### Startup instructions
___
The function **reverse** takes one single argument
- relative path to the file
```
reverse __fixtures__/file2.txt
```
### Example of work
[](https://asciinema.org/a/HtI1UKqeQkk33L027rTN8Lwgz)
## Module build
### Description
___
:warning: **Be careful when using this module**: This module can mutate the file system (add new files)!
This module checks if a file has been created and if it has not been created, creates it. The module returns "Succes!" anyway, even if the file is created
### Startup instructions
___
The function **build** takes one single argument
- relative path to the file
```
build __fixtures__/file1.txt
```
### Example of work
[](https://asciinema.org/a/ThQ5lIhDDMh1IXB50ZmBZE0bg)
## Module getTypes
### Description
___
This software module returns an array of types of passed paths. If the path is incorrect or non-existent, the function returns null.
### Startup instructions
___
This module **getTypes** accepts an unlimited number of paths separated by a space as input
- ... relative path to the file
```
getTypes __fixtures__/file1.txt _fixtures__/file2.txt __fixtures__/file3.txt
```
### Example of work
[](https://asciinema.org/a/gtvAUfNBzgxGenrjbrnIsxsob)
## Module compareFilesSizes
### Description
___
This module compares the sizes of the transferred files and outputs the path to the file with the largest size to the console.
### Startup instructions
___
This module **compareFilesSizes** accepts an unlimited number of file paths. If a directory has been passed, it is ignored.
- ... relative path to the file
```
compareFilesSizes __fixtures__/file1.txt _fixtures__/file2.txt __fixtures__/file3.txt
```
### Example of work
[](https://asciinema.org/a/0Ai1lefFTpQW3DeMrIss3uIBX)
## Module exchange
### Description
___
This module compares the sizes of the transferred files and outputs the path to the file with the largest size to the console.
### Startup instructions
___
This module **compareFilesSizes** accepts an unlimited number of file paths. If a directory has been passed, it is ignored.
- ... relative path to the file
```
compareFilesSizes __fixtures__/file1.txt _fixtures__/file2.txt __fixtures__/file3.txt
```
### Example of work
[](https://asciinema.org/a/HUp3HFfb3XZWbE2E9ZK5sYFaz)