Skip to content

Commit 1b1b43a

Browse files
authored
Merge pull request #94 from MatrixAI/feature-integrate-js-lint
Integrate js-lint and removing old linting elements
2 parents 1dc7fcf + b13b208 commit 1b1b43a

File tree

8 files changed

+3227
-1037
lines changed

8 files changed

+3227
-1037
lines changed

.eslintrc

-179
This file was deleted.

README.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,12 @@
22

33
Encrypted filesystem library for TypeScript/JavaScript applications
44

5-
* Virtualised - files, directories, permissions are all virtual constructs, they do not correspond to real filesystems
6-
* Orthogonally Persistent - all writes automatically persisted
7-
* Encrypted-At-Rest - all persistence is encrypted
8-
* Random Read & Write - encryption and decryption operates over fixed-block sizes
9-
* Streamable - files do not need to loaded fully in-memory
10-
* Comprehensive continuous benchmarks in CI/CD
5+
- Virtualised - files, directories, permissions are all virtual constructs, they do not correspond to real filesystems
6+
- Orthogonally Persistent - all writes automatically persisted
7+
- Encrypted-At-Rest - all persistence is encrypted
8+
- Random Read & Write - encryption and decryption operates over fixed-block sizes
9+
- Streamable - files do not need to loaded fully in-memory
10+
- Comprehensive continuous benchmarks in CI/CD
1111

1212
Development based on js-virtualfs: https://github.com/MatrixAI/js-virtualfs
1313

@@ -34,7 +34,7 @@ const efs = await EncryptedFS.createEncryptedFS({
3434

3535
// optionally set up the worker manager for multi-threaded encryption/decryption
3636
const workerManager = await WorkerManager.createWorkerManager<EFSWorkerModule>({
37-
workerFactory: () => spawn(new Worker('./src/workers/efsWorker'))
37+
workerFactory: () => spawn(new Worker('./src/workers/efsWorker')),
3838
});
3939

4040
efs.setWorkerManager(workerManager);
@@ -64,10 +64,10 @@ Internally we use the AES-GCM symmetric encryption using a master `dbKey` that c
6464

6565
The `dbKey` can be generated from several methods:
6666

67-
* `generateKey` - random asynchronous
68-
* `generateKeySync` - random synchronous
69-
* `generateKeyFromPass` - derived from user-provided "password" asynchronous
70-
* `generateKeyFromPassSync` - derived from user-provided "password" synchronous
67+
- `generateKey` - random asynchronous
68+
- `generateKeySync` - random synchronous
69+
- `generateKeyFromPass` - derived from user-provided "password" asynchronous
70+
- `generateKeyFromPassSync` - derived from user-provided "password" synchronous
7171

7272
For example:
7373

@@ -95,9 +95,9 @@ The ciphertext data length is equal to the plaintext block length.
9595

9696
There are some differences between EFS and Node FS:
9797

98-
* User, Group and Other permissions: In EFS User, Group and Other permissions are strictly confined to their permission class. For example, a User in EFS does not have the permissions that a Group or Other has while in Node FS a User also has permissions that Group and Other have.
99-
* Sticky Files: In Node FS, a sticky bit is a permission bit that is set on a file or a directory that lets only the owner of the file/directory or the root user to delete or rename the file. EFS does not support the use of sticky bits.
100-
* Character Devices: Node FS contains Character Devices which can be written to and read from. However, in EFS Character Devices are not supported yet.
98+
- User, Group and Other permissions: In EFS User, Group and Other permissions are strictly confined to their permission class. For example, a User in EFS does not have the permissions that a Group or Other has while in Node FS a User also has permissions that Group and Other have.
99+
- Sticky Files: In Node FS, a sticky bit is a permission bit that is set on a file or a directory that lets only the owner of the file/directory or the root user to delete or rename the file. EFS does not support the use of sticky bits.
100+
- Character Devices: Node FS contains Character Devices which can be written to and read from. However, in EFS Character Devices are not supported yet.
101101

102102
## Development
103103

0 commit comments

Comments
 (0)