seroval 0.2.1 → 0.4.0-alpha.0

package/README.md

@@ -58,25 +58,25 @@ const result = serialize(object);
 Output (as a string):
 
 ```js
-((h,j,k,m)=>(h={number:[0.5906513825027921,-0,NaN,Infinity,-Infinity],string:["hello world","\x3Cscript>Hello World\x3C/script>"],boolean:[!0,!1],null:null,undefined:void 0,bigint:BigInt("9007199254740991"),array:j=[,,,,k=new Map([["hello","world"],["mutual",m=new Set(["hello","world"])]])],regexp:/[a-z0-9]+/i,date:new Date("2023-02-06T06:16:00.384Z"),map:k,set:m},j[3]=j,h.self=h,k.set("self",k),m.add(m).add(j),h))()
+((h,j,k,m)=>(m={number:[0.5623457676854244,-0,NaN,1/0,-1/0],string:["hello world","\x3Cscript>Hello World\x3C/script>"],boolean:[!0,!1],null:null,undefined:void 0,bigint:9007199254740991n,array:h=[,,,,j=new Map([["hello","world"],["mutual",k=new Set(["hello","world"])]])],regexp:/[a-z0-9]+/i,date:new Date("2023-03-14T11:16:24.879Z"),map:j,set:k},h[3]=h,j.set("self",j),k.add(k).add(h),m.self=m,m))()
 
 // Formatted for readability
-((h, j, k, m) => (h = {
-  number: [0.5906513825027921, -0, NaN, Infinity, -Infinity],
+((h, j, k, m) => (m = {
+  number: [0.5623457676854244, -0, NaN, 1 / 0, -1 / 0],
   string: ["hello world", "\x3Cscript>Hello World\x3C/script>"],
   boolean: [!0, !1],
   null: null,
   undefined: void 0,
-  bigint: BigInt("9007199254740991"),
-  array: j = [, , , , k = new Map([
+  bigint: 9007199254740991n,
+  array: h = [, , , , j = new Map([
     ["hello", "world"],
-    ["mutual", m = new Set(["hello", "world"])]
+    ["mutual", k = new Set(["hello", "world"])]
   ])],
   regexp: /[a-z0-9]+/i,
-  date: new Date("2023-02-06T06:16:00.384Z"),
-  map: k,
-  set: m
-}, j[3] = j, h.self = h, k.set("self", k), m.add(m).add(j), h))()
+  date: new Date("2023-03-14T11:16:24.879Z"),
+  map: j,
+  set: k
+}, h[3] = h, j.set("self", j), k.add(k).add(h), m.self = m, m))()
 ```
 
 ### Mutual cyclic example
@@ -102,7 +102,7 @@ const result = serialize({ a, b, c, d });
 Output (as a string):
 
 ```js
-((h,j,k,m,o,q)=>(q={a:h=new Map([["name","a"],["children",[j=new Map([["name","c"],["right",k=new Map([["name","b"],["children",o=[,m=new Map([["name","d"]])]]])]]),m]]]),b:k,c:j,d:m},o[0]=j,j.set("left",h),m.set("left",h).set("right",k),q))()
+((h,j,k,m,o,q)=>(q={a:h=new Map([["name","a"],["children",[j=new Map([["name","c"],["right",o=new Map([["name","b"],["children",k=[,m=new Map([["name","d"]])]]])]]),m]]]),b:o,c:j,d:m},j.set("left",h),k[0]=j,m.set("left",h).set("right",o),q))()
 
 // Formatted
 ((h, j, k, m, o, q) => (q = {
@@ -110,18 +110,18 @@ Output (as a string):
     ["name", "a"],
     ["children", [j = new Map([
       ["name", "c"],
-      ["right", k = new Map([
+      ["right", o = new Map([
         ["name", "b"],
-        ["children", o = [, m = new Map([
+        ["children", k = [, m = new Map([
           ["name", "d"]
         ])]]
       ])]
     ]), m]]
   ]),
-  b: k,
+  b: o,
   c: j,
   d: m
-}, o[0] = j, j.set("left", h), m.set("left", h).set("right", k), q))()
+}, j.set("left", h), k[0] = j, m.set("left", h).set("right", o), q))()
 ```
 
 ## Deserialization
@@ -172,9 +172,115 @@ The following values are the only values accepted by `seroval`:
   - `Date`
   - `Map`
   - `Set`
+- `TypedArray`
+  - `Int8Array`
+  - `Int16Array`
+  - `Int32Array`
+  - `Uint8Array`
+  - `Uint16Array`
+  - `Uint32Array`
+  - `Uint8ClampedArray`
+  - `Float32Array`
+  - `Float64Array`
+  - `BigInt64Array`
+  - `BigUint64Array`
+- `Error`
+  - `AggregateError`
+  - `EvalError`
+  - `RangeError`
+  - `ReferenceError`
+  - `SyntaxError`
+  - `TypeError`
+  - `URIError`
 - `Promise` (with `serializeAsync`)
+- [`Iterable`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_iterable_protocol)
 - Cyclic references (both self and mutual)
 
+## Compat
+
+`serialize` and `serializeAsync` can accept a `{ target: string | string[] }` options. The `target` property decides what the serialization output would look like. The default target is `es2023`.
+
+```js
+import { serialize } from 'seroval';
+
+const y = Object.create(null);
+y.self = y;
+y.example = 'Hello World';
+
+function serializeWithTarget(value, target) {
+  console.log('Target is', target)
+  const result = serialize(value, {
+    target,
+  });
+  console.log(result);
+}
+
+serializeWithTarget(y, 'es5');
+serializeWithTarget(y, 'es2023');
+```
+
+Output
+
+```
+Target is es5
+(function(h){return (h=Object.create(null),h.self=h,h.example="Hello World",h)})()
+Target is es2023
+(h=>(h=Object.assign(Object.create(null),{example:"Hello World"}),h.self=h,h))()
+```
+
+You can also combine targets:
+
+```js
+serialize(value, {
+  targets: ['chrome85', 'edge85'],
+});
+```
+
+Supported runtimes:
+
+- `es`
+  - Valid values are `es5`, `es6` and above (e.g. `es2020`).
+- Desktop
+  - `chrome`
+  - `edge`
+  - `safari`
+  - `firefox`
+  - `opera`
+- Mobile
+  - `ios`
+  - `samsung`
+- Runtimes
+  - `deno`
+  - `node`
+
+> **Note**
+> Version for runtimes excluding `es` can use semver format (`major.minor.patch`) e.g. `chrome110`, `node0.12`
+
+Feature flags and compat attempt:
+
+- `AggregateError`
+  - Compiles down to `Error` instead.
+- `Array.prototype.values`
+  - Used for iterables, uses `Symbol.iterator` instead.
+- Arrow functions
+  - Uses function expressions for top-level, and either method shorthands or function expressions for iterables.
+- `BigInt`
+  - Throws when attempted to use, includes `BigInt64Array` and `BigUint64Array`
+- `Map`
+  - Throws when attempted to use.
+- Method shorthands
+  - Uses function expressions instead.
+- `Object.assign`
+  - Uses manual object assignments instead.
+- `Promise`
+  - Throws when attempted to use, specially in `serializeAsync`.
+- `Set`
+  - Throws when attempted to use.
+- `Symbol.iterator`
+  - Throws when attempted to use.
+- `TypedArray`
+  - Throws when attempted to use.
+
 ## Sponsors
 
 ![Sponsors](https://github.com/lxsmnsyc/sponsors/blob/main/sponsors.svg?raw=true)