0.3.6 ā¢ Published 3 years ago
sync-files-cipher v0.3.6
One-way encrypted client-server file synchronization (mirroring) package in nodejs over sockets (SFC)
š Homepage
Install
npm install sync-files-cipher
How to use server
const { createServer } = require('sync-files-cipher')
createServer(
'8BZ3pCTp71LX5I//QsBYdz7w4JHXNVehSBXuXnScdqg=',
'AAAAAAAAAAAAAAAAAAAAAA==',
() => { console.log("Server listening");}
)
CreateServer function
Create a socket server and start listen connections, return a nodejs net.Server instance
createServer(aesKey, iv, onLIstenCallback, port )
Argument | Type | Description |
---|---|---|
aesKey | String | The key is the raw key used by the algorithm. Must be utf8 encoded string, see nodejs crypto for more details. |
iv | String | Is an initialization vector. Must be utf8 encoded string, see nodejs crypto for more details. |
onLIstenCallback | Function | The callback when server is listening. |
port | Number | The port, default 9000. |
How to use client
const { sync } = require('sync-files-cipher')
// start to sync files or directory
const watcher = await sync(
'/clientpath',
function (eventType, pathChanged) {
console.log(eventType, pathChanged);
},
function (error) {
console.log(error);
},
'/prefix'
);
// stop sync
watcher.close()
.then(() => console.log("Watcher closed"))
Sync function
Sync the file client with backup files when there are changes, return a nodejs FSWatcher instance
sync (pathToWatch, userWatchCallback, userErrorCallback, pathPrefix, port, host
)
Argument | Type | Description |
---|---|---|
pathToWatch | String | The path to watch. |
userWatchCallback | Function | The callback to call when sync is executed and passes the enent type and the path changed. |
userErrorCallback | Function | The callback to call when sync is crashed. |
pathPrefix | String | The prefix path for use in server for sync upfiles, default empty. |
port | Number | The server port, default 9000 |
host | String | The prefix path, default empty |
Event types
Type | Description |
---|---|
ADD_DIR | Runs when a directory is added. |
SYNC | It runs when they add a new file or file change. |
REMOVE_DIR | Runs when a directory is deleted. |
REMOVE_FILE | Runs when a file is deleted. |
Close function
Stop watching.
watcherInstance.close()
.then(() =>
console.log("Watcher closed"))
Authors
š¤ Juan Francisco Javier Perez Rivero, Deiver Guerra Carrascal
- Github: @oneCiser
- Github: @ingDeiver
š¤ Contributing
Contributions, issues and feature requests are welcome!Feel free to check issues page.
Show your support
Give a āļø if this project helped you!
š License
Copyright Ā© 2021 Juan Francisco Javier Perez Rivero, Deiver Guerra Carrascal. This project is MIT licensed.
This README was generated with ā¤ļø by readme-md-generator