The type registry for typeson.
See below for notes on these types and presets.
Note that some types will require polyfills in Node such as via
jsdom.
See the testing environment of test/test.js for some examples.
Note that for Node.js, to use the file or blob types (or the filelist
type or structuredCloning and structuredCloningThrowing presets which
include them), you will need a polyfill for Blob or File, respectively,
as well as FileReader and URL.createObjectURL (and a
polyfill for URL if you are using Node < 10.0.0 or an older browser).
Note that our URL.createObjectURL polyfill expects a global
XMLHttpRequest and location.href predefined before it as well (and one
which can handle data: URLs). For Node, you can add it like this:
const url = require('url'); // This line only needed to support Node < 10.0.0
const {createObjectURL} = require('typeson-registry/polyfills/createObjectURL.umd.cjs');
const URL = url.Url; // This line only needed to support Node < 10.0.0
URL.createObjectURL = createObjectURL;We have not added jsdom as a dependency, but it is required if this
polyfill is used.
Besides the polyfills for file or blob, the structuredCloningThrowing
preset also needs a global DOMException polyfill.
The filelist type, in addition to the polyfills for file, will need
a FileList polyfill (including a FileList string tag).
The imagebitmap type requires a global createImageBitmap polyfill (and
an ImageBitmap polyfill (including an ImageBitmap string tag).
The imagedata type requires a global ImageData polyfill (including an
ImageData string tag).
You may wish to see our test-environment.js file for how some
polyfilling may be done (largely using jsdom).
If you have cloned the repo (and not the npm package), you must run
npm install to get the devDependencies and then run
npm run rollup to get the individual browser scripts built locally
(into dist) or to get index.js to be rebuilt based on existing
presets and types).
import {Typeson, date, error, regexp, typedArrays} from 'typeson-registry';
const TSON = new Typeson().register([
date,
error,
regexp,
typedArrays
// ...
]);
const tson = TSON.stringify({
Hello: 'world',
date: new Date(),
error: new Error('test'),
inner: {
x: /foo/gui,
bin: new Uint8Array(64)
}
}, null, 2);
console.log(tson);
/* Output:
{
"Hello": "world",
"date": 1464049031538,
"error": {
"name": "Error",
"message": "test"
},
"inner": {
"x": {
"source": "foo",
"flags": "gi"
},
"bin": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=="
},
"$types": {
"date": "Date",
"error": "Error",
"inner.x": "RegExp",
"inner.bin": "Uint8Array"
}
}
*/
const parsedBack = TSON.parse(tson);
console.log(parsedBack.date instanceof Date);
console.log(parsedBack.inner.bin instanceof Uint8Array);const {Typeson, builtin} = require('typeson-registry');
const tson = new Typeson().register([
builtin
]);<script type="module">
import {Typeson, builtin} from './node_modules/typeson-registry/dist/index.js';
const TSON = new Typeson().register([
builtin
]);
</script>All types and presets under dist/ are UMD modules so you could also
require them as AMD modules with requirejs if you prefer.
<!DOCTYPE html>
<html>
<head>
<script src="https://unpkg.com/typeson/dist/typeson.umd.min.js"></script>
<script src="https://unpkg.com/typeson-registry/dist/presets/builtin.umd.cjs"></script>
<script>
const TSON = new Typeson().register(builtin);
const tson = TSON.stringify({
Hello: 'world',
date: new Date(),
error: new Error('err'),
inner: {
x: /foo/giu,
bin: new Uint8Array(64)
}
}, null, 2);
alert(tson);
/* Alerts:
{
"Hello": "world",
"date": 1464049031538,
"error": {
"name": "Error",
"message": "err"
},
"inner": {
"x": {
"source": "foo",
"flags": "gi"
},
"bin": "AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=="
},
"$types": {
"date": "Date",
"error": "Error",
"inner.x": "RegExp",
"inner.bin": "Uint8Array"
}
}
*/
</script>
</head>
</html>Note that the type name corresponds to the file name in the following manner:
- Genuine separate words are camel-cased in the type name but hyphenated in
the file name (e.g.,
negativeInfinityandnegativity-infinity.js); names whose original API is camel-cased are not hyphenated, however (e.g.,arraybufferandarraybuffer.jsgivenArrayBuffer). - All other portions of names are lower-cased (e.g.,
dateanddate.js). - Type names that would clash with existing objects when exported (even after
lower-casing) must have a separate, preferably abbreviated form (e.g.,
the type and preset
undefandundef.jswas necessary forundefined) - Type names which are not allowed as ES6 exports (e.g., periods in
Intltypes are now removed:Intl.Collator->IntlCollator) - Type names should indicate the singular (e.g.,
userObject) except for files containing multiple related exports (e.g.,errors,typed-arrays, andtyped-arrays-socketio.js); files with multiple exports whose extra exports are incidental (e.g.,filelist) do not need a plural.
arraybufferbigintObjectbigintblob- Has sync and async encapsulation/replacements (though sync only via deprecated means)cloneable- Looks forSymbol.for('cloneEncapsulate')andSymbol.for('cloneRevive')methods to allow for a means of extending our built-in structured cloning presets (though if you are polyfilling a standard object, we welcome you to submit back as a PR!). The clones cannot be revived past the current window session, however.cryptokeydataviewdatedomexceptiondommatrixdommatrixreadonlydompointdompointreadonlydomquaddomrectdomrectreadonlyerror.js(Error) anderrors.js(TypeError,RangeError,SyntaxError,ReferenceError,EvalError,URIError,InternalError) - These provide a means of resurrecting error object across cloning boundaries (since they are not otherwise treated as cloneable by the Structured Cloning Algorithm).file- Has sync and async encapsulation/replacements (though sync only via deprecated means)filelist- HTML does not provide a means of creating aFileListobject dynamically, so we polyfill one for revival. This method also setsFileimagebitmap- Has sync and async revivers. IfOffscreenCanvasis not supported, the sync method does not produce a genuineImageBitmapbut instead produces a canvas element which can frequently be used in a similar context toImageBitmap.imagedatainfinity- Preserves positive infinityintl-types.js(Intl.Collator,Intl.DateTimeFormat,Intl.NumberFormat) - Not all properties can be preservedmapnan- PreservesNaN(not a number)negativeInfinity- Preserves negative infinitynegativeZero- Preserves-0(produces + or - Infinity when used as divisor)nonBuiltInIgnore- For roughly detecting non-builtin objects and to avoid adding them as propertiesprimitive-objects.js(StringObject,BooleanObject,NumberObject)promiseregexpresurrectable- Resurrects any non-array object, function, or symbol; can only be revived for the current window session.setsymboltyped-arrays-socketio.js(Int8Array,Uint8Array,Uint8ClampedArray,Int16Array,Uint16Array,Int32Array,Uint32Array,Float32Array,Float64Array) - See typeson#environmentformat-support andpresets/socketio.jstyped-arrays.js(Int8Array,Uint8Array,Uint8ClampedArray,Int16Array,Uint16Array,Int32Array,Uint32Array,Float32Array,Float64Array) - Base64-encodesundef(forundefined) (See alsopresets/undefined.jsandpresets/sparse-undefined.js)userObjects- Allows for inherited objects but ensures the prototype chain inherits fromObject(ornull). Should be low priority if one is matching other objects as it will readily match many objects.
array-nonindex-keys.jsbuiltin.js- Types that are built into the JavaScript language itself. Types that were added in ES6 or beyond will be checked before inclusion so that this module can be consumed by both ES5 and ES6 environments. Some imperfectly serializable objects (such as functions and Symbols) are not included in this preset.postmessage.js- This preset is intended as a utility to expand on what is cloneable viastrcutured-cloning.jsand supports Error objects.socketio.jssparse-undefined.js(sparseArraysandsparseUndefined) - Supports reconstructing sparse arrays (with missing properties not even assigned an explicitundefined). Seetypes/undefined.jsfor the explicit case orpresets/undefined.jsfor a utility combining both.special-numbers.js(preservesNaN,Infinity,-Infinity)structured-cloning.js- For the Structured Cloning Algorithm used by the likes ofpostMessageandindexedDB. See also thecloneabletype.structured-cloning-throwing.js- Same asstructured-cloning.jsbut throws with non-recognized types. See also thecloneabletype.undef.js- Supports reconstructing explicit and implicit (sparse) uses ofundefined.universal.js- Meant for de-facto universal types. Currently includes built-ins only.
If you are looking for a way to resurrect functions, you can use the following,
but please bear in mind that it uses eval which is prohibited by some
Content Security Policies (CSP) (so we are not packaging it with our builds),
that it is unsafe, and also that the function might not behave
deterministically when revived (e.g., if the function were provided from
another context).
const functionType = {functionType: [
function (x) { return typeof x === 'function'; },
function (funcType) { return '(' + funcType.toString() + ')'; },
// eslint-disable-next-line no-eval -- Demonstrating
function (o) { return eval(o); }
]};
const typeson = new Typeson().register(functionType);
const tson = typeson.stringify(function () { return 'abc'; });
const back = typeson.parse(tson);
back(); // 'abc'node-canvas is used to test
ImageData.
Be sure to follow the installation steps.
On Windows, besides following the
Windows installation steps,
this
helped complete the installation. If you need to have it rebuilt, you can
run npm i inside of the node_modules/canvas directory.
These steps
were also necessary but you can run npm run windows after install to get
these steps applied. These are the only steps which should need to be re-run
if you have deleted your local node-canvas copy.