transit-js: transit

Create a transit big decimal.

• s <String>

  A string representing an arbitrary precisions decimal value.

Create a transit big integer.

• s <String>

  A string representing an arbitrary size integer value.

Create transit binary blob.

• s <String>

  A base64 encoded string.

Create a transit date.

• A <Number | String>

  number or string representing milliseconds since epoch.

Construct a Transit JSON decoder.

• options <Object>

  to the decoder. Can include map of handlers.

Example

var decoder = transit.decoder();
var x = decoder.decode(json, transit.readCache());

Extend an object to hashing and equality required by transit maps and sets. Only required for custom types, JavaScript primitive types and transit types are handled.

• x <Object>

  A JavaScript object, will be mutated.

Example

transit.extendToEq(Point.protototype, {
    hashCode: function() {
        var bits = (this.x | 0) ^ ((this.y | 0) * 31);
        return bits ^ (bits >>> 32);
    },
    equals: function(other) {
        return this.x == other.x && this.y == other.y;
    }
});

Compute the hashCode for any JavaScript object that has been extend to transit's equality and hashing protocol. JavaScript primitives and transit value are already extended to this protocol. Custom types may be extended to the protocol via transit.extenToEQ.

• x <Object>

  Any JavaScript object that has been extended to transit's equality and hashing protocol.

Compute the hashCode for JavaScript array-like types - either a JavaScript array or a JavaScript object that implements Array forEach.

• x <Object>

  A JavaScript Array or Object that implements Array forEach.

Compute the hashCode for JavaScript map-like types - either a JavaScript object or a JavaScript object that implements ES6 Map forEach.

• x <Object>

  A plain JavaScript Object or Object that implements ES6 Map forEach.

Create an integer. If given a transit integer or a JavaScript number will simply return that value. Given a string will return a JavaScript number if the string represents an integer value in the 53bit range and a transit integer otherwise.

• s <Number | String>

  A value representing an integer.

Test if an object is a transit big decimal.

• x <Object>

  Any JavaScript value.

Test if an object is a transit big integer.

• x <Object>

  Any JavaScript value.

Test if an object is a transit binary blob.

• x <Object>

  Any JavaScript value.

Test if an object is a transit integer. Will return true if argument is a 64 bit integer or a JavaScript number that has an interpretation as an integer value, i.e. parseFloat(n) === parseInt(n)

• x <Object>

  Any JavaScript value.

Test if an object is a transit keyword.

• x <Object>

  Any JavaScript value.

Test if an object is a transit link.

• x <Object>

  Any JavaScript object.

Test if an object is a transit list.

• x <Object>

  Any JavaScript value.

Test if an object is a transit map.

• x <Object>

  Any JavaScript value.

Test if an object is a transit quoted value.

• x <Object>

  Any JavaScript value.

Test if an object is a transit set.

• x <Object>

  Any JavaScript value.

Test if an object is a transit symbol

• x <Object>

  Any JavaScript value.

Test if an object is a transit tagged value.

• x <Object>

  Any JavaScript value.

Test if an object is a transit URI.

• Any <Object>

  JavaScript value.

Test if an object is a transit UUID.

• x <Object>

  Any JavaScript value.

Create transit keyword.

• name <String>

  A string.

Example

transit.keyword("foo");

Create a transit link.

• A <com.cognitect.transit.types.TransitArrayMap | com.cognitect.transit.types.TransitMap>

  transit map which must contain at a minimum the following keys: href, rel. It may optionally include name, render, and prompt. href must be a transit.uri, all other values are strings, and render must be either "image" or "link".

Create a transit list.

• A <Array>

  JavaScript array.

Create a transit writer handler.

• obj <Object>

  An object containing 3 functions, tag, rep and stringRep. "tag" should return a string representing the tag to be written on the wire. "rep" should return the representation on the wire. "stringRep" is should return the string representation of the value. Optional "getVerboseHandler" should return a handler for writing verbose output.

Example

var PointHandler = transit.makeWriteHandler({
     tag: function(p) { return "point"; },
     rep: function(p) { return [p.x, p.y]; },
     stringRep: function(p) { return null; }
});

Create a transit hash map. Transit maps satisfy the current version of the ECMAScript 6 Map specification.

• xs <Array>

  A JavaScript array of alternating key value pairs.

Example

transit.map([new Date(), "foo", [1,2], 3]);

Convert a transit map instance into a JavaScript Object. Throws if the map has keys which have no string representation.

• m <com.cognitect.transit.types.TransitArrayMap | com.cognitect.transit.types.TransitMap>

  a transit map

Convert a POJO into a transit map.

• a <Object>

  JavaScript Object

Create a transit quoted value.

• x <Object>

  Any JavaScript value.

Construct a Transit read cache

Create a transit reader instance.

• type <String=>

  type of reader to construct. Default to "json". For verbose mode supply "json-verbose".

• opts <Object=>

  reader options. A JavaScript object to customize the writer Valid entries include "defaultHandler", and "handler". "defaultHandler" should be JavaScript function taking two arguments, the first is the tag, the second the value. "handlers" should be an object of tags to handle. The values are functions that will receive the value of matched tag. "preferBuffers" may be supplied to customize binary decoding. If available binary data will read as Node.js Buffers, If Buffer is not available or "prefersBuffers" is set to false data will be read as Uint8Array. If neither Buffer nor Uint8Array is available - defaults to tagged value that simply wraps the base64 encoded string.

Example

var r = transit.reader("json", {
    handlers: {
       "point": function(v) { return new Point(v[0], v[1]); }
    }
});

Create a transit set. Transit sets satisfy the current version of the of the ECMAScript 6 Set specification.

• xs <Array>

  A JavaScript array of values.

Example

transit.set(["foo", [1,2], 3, {bar: "baz"}]);

Create a transit symbol.

• name <String>

  A string.

Example

transit.symbol("foo");

Create a transit tagged value.

• tag <String>

  A tag.

• value <Object>

  A JavaScrpt array, object, or string.

Example

transit.tagged("point", new Point(1,2));

Create a transit URI.

• A <String>

  string representing a valid URI.

Create transit UUID from a string

• UNKNOWN <String>

Construct a Transit write cache

Create a transit writer instance.

• type <String=>

  type of writer to construct. Defaults to "json". For verbose mode supply "json-verbose".

• opts <Object=>

  writer options. A JavaScript object to customize the writer. "handlers" options, a transit.map of JavaScript constructor and transit writer handler instance entries. "handlerForForeign" option, for dealing with values from other JavaScript contexts. This function will be passed the unmatchable value and the installed handlers. The function should return the correct handler. Note if this function is provided, special handling for Objects will also be auto-installed to catch plain Objects from the foreign context.

Example

var r = transit.writer("json", {
    handlers: transit.map([
       Point, PointHandler
    ])
});