@@ -30,15 +30,15 @@ import * as snapshot from 'memfs/lib/snapshot';
30
30
You can convert any folder of an ` fs ` -like file system into a POJO snapshot.
31
31
32
32
``` ts
33
- const snap = snapshot .toSnapshotSync ({ fs , dir });
34
- const snap = await snapshot .toSnapshot ({ fs: fs .promises , dir });
33
+ const snap = snapshot .toSnapshotSync ({ fs , path });
34
+ const snap = await snapshot .toSnapshot ({ fs: fs .promises , path });
35
35
```
36
36
37
37
Then import it back from snapshot.
38
38
39
39
``` ts
40
- snapshot .fromSnapshotSync (snap , { fs , dir });
41
- await snapshot .fromSnapshot (snap , { fs: fs .promises , dir });
40
+ snapshot .fromSnapshotSync (snap , { fs , path });
41
+ await snapshot .fromSnapshot (snap , { fs: fs .promises , path });
42
42
```
43
43
44
44
## Binary snapshot
@@ -47,15 +47,15 @@ Binary snapshots are encoded as CBOR `Uint8Array` buffers. You can convert any
47
47
folder of an ` fs ` -like file system into a ` Uint8Array ` snapshot.
48
48
49
49
``` ts
50
- const uint8 = snapshot .toBinarySnapshotSync ({ fs , dir });
51
- const uint8 = await snapshot .toBinarySnapshot ({ fs: fs .promises , dir });
50
+ const uint8 = snapshot .toBinarySnapshotSync ({ fs , path });
51
+ const uint8 = await snapshot .toBinarySnapshot ({ fs: fs .promises , path });
52
52
```
53
53
54
54
Then import it back from ` Uint8Array ` snapshot.
55
55
56
56
``` ts
57
- snapshot .fromBinarySnapshotSync (uint8 , { fs , dir });
58
- await snapshot .fromBinarySnapshot (uint8 , { fs: fs .promises , dir });
57
+ snapshot .fromBinarySnapshotSync (uint8 , { fs , path });
58
+ await snapshot .fromBinarySnapshot (uint8 , { fs: fs .promises , path });
59
59
```
60
60
61
61
## JSON snapshot
@@ -67,15 +67,15 @@ data is encoded as Base64 data URL strings. The resulting JSON is returned as
67
67
You can convert any folder of an ` fs ` -like file system into a ` Uint8Array ` snapshot.
68
68
69
69
``` ts
70
- const uint8 = snapshot .toJsonSnapshotSync ({ fs , dir });
71
- const uint8 = await snapshot .toJsonSnapshot ({ fs: fs .promises , dir });
70
+ const uint8 = snapshot .toJsonSnapshotSync ({ fs , path });
71
+ const uint8 = await snapshot .toJsonSnapshot ({ fs: fs .promises , path });
72
72
```
73
73
74
74
Then import it back from ` Uint8Array ` snapshot.
75
75
76
76
``` ts
77
- snapshot .fromJsonSnapshotSync (uint8 , { fs , dir });
78
- await snapshot .fromJsonSnapshot (uint8 , { fs: fs .promises , dir });
77
+ snapshot .fromJsonSnapshotSync (uint8 , { fs , path });
78
+ await snapshot .fromJsonSnapshot (uint8 , { fs: fs .promises , path });
79
79
```
80
80
81
81
## Encoding format
0 commit comments