diff options
author | Joel Kronqvist <joel.h.kronqvist@gmail.com> | 2022-03-05 19:02:27 +0200 |
---|---|---|
committer | Joel Kronqvist <joel.h.kronqvist@gmail.com> | 2022-03-05 19:02:27 +0200 |
commit | 5d309ff52cd399a6b71968a6b9a70c8ac0b98981 (patch) | |
tree | 360f7eb50f956e2367ef38fa1fc6ac7ac5258042 /node_modules/jest-serializer/README.md | |
parent | b500a50f1b97d93c98b36ed9a980f8188d648147 (diff) | |
download | LYLLRuoka-5d309ff52cd399a6b71968a6b9a70c8ac0b98981.tar.gz LYLLRuoka-5d309ff52cd399a6b71968a6b9a70c8ac0b98981.zip |
Added node_modules for the updating to work properly.
Diffstat (limited to 'node_modules/jest-serializer/README.md')
-rw-r--r-- | node_modules/jest-serializer/README.md | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/node_modules/jest-serializer/README.md b/node_modules/jest-serializer/README.md new file mode 100644 index 0000000..43c8bb1 --- /dev/null +++ b/node_modules/jest-serializer/README.md @@ -0,0 +1,47 @@ +# jest-serializer + +Module for serializing and deserializing object into memory and disk. By default, the `v8` implementations are used, but if not present, it defaults to `JSON` implementation. Both serializers have the advantage of being able to serialize `Map`, `Set`, `undefined`, `NaN`, etc, although the JSON one does it through a replacer/reviver. + +## Install + +```sh +$ yarn add jest-serializer +``` + +## API + +Three kinds of API groups are exposed: + +### In-memory serialization: `serialize` and `deserialize` + +This set of functions take or return a `Buffer`. All the process happens in memory. This is useful when willing to transfer over HTTP, TCP or via UNIX pipes. + +```javascript +import {deserialize, serialize} from 'jest-serializer'; + +const myObject = { + foo: 'bar', + baz: [0, true, '2', [], {}], +}; + +const buffer = serialize(myObject); +const myCopyObject = deserialize(buffer); +``` + +### Synchronous persistent filesystem: `readFileSync` and `writeFileSync` + +This set of functions allow to send to disk a serialization result and retrieve it back, in a synchronous way. It mimics the `fs` API so it looks familiar. + +```javascript +import {readFileSync, writeFileSync} from 'jest-serializer'; + +const myObject = { + foo: 'bar', + baz: [0, true, '2', [], {}], +}; + +const myFile = '/tmp/obj'; + +writeFileSync(myFile, myObject); +const myCopyObject = readFileSync(myFile); +``` |