Node Js Php Serializer
I am interested in finding out what binary serialization frameworks/libraries are there for node.js. I tried to use Apache Thrift, but the documentation is very poor and does not offer any exampl. I have just started exploring Node.js as I am planning to work on a project very soon using Node.js. Saving XML filen in Node.js [duplicate]. Javascript php. You can customize the HTML output of a prismic.io Rich Text Field by incorporating an HTML Serializer with Node.js. This allows you to do things like adding custom classes to certain elements or adding a target element to all hyperlinks. Exploiting Node.js deserialization bug for Remote Code Execution. February 8, 2017; Blog; tl;dr. Untrusted data passed into unserialize() function in node-serialize module can be exploited to achieve arbitrary code execution by passing a serialized JavaScript Object with an Immediately invoked function expression (IIFE).
A Node.js framework agnostic library for (de)serializing your data to JSONAPI (1.0 compliant).
Installation
$ npm install jsonapi-serializer
Documentation
Serialization
The function JSONAPISerializer
takes two arguments:
type
: The resource type.opts
: The serialization options.
Calling the serialize
method on the returned object will serialize your data
(object or array) to a compliant JSONAPI document.
Available serialization option (opts
argument)
- attributes: An array of attributes to show. You can define an attribute as an option if you want to define some relationships (included or not).
- ref: If present, it's considered as a relationships.
- included: Consider the relationships as compound document. Default: true.
- id: Configurable identifier field for the resource. Default:
id
. - attributes: An array of attributes to show.
- topLevelLinks: An object that describes the top-level links. Values can be string or a function
- dataLinks: An object that describes the links inside data. Values can be string or a function (see examples below)
- dataMeta: An object that describes the meta inside data. Values can be a plain value or a function (see examples below)
- relationshipLinks: An object that describes the links inside relationships. Values can be string or a function
- relationshipMeta: An object that describes the meta inside relationships. Values can be a plain value or a function
- ignoreRelationshipData: Do not include the
data
key inside the relationship. Default: false. - keyForAttribute: A function or string to customize attributes. Functions are passed the attribute as a single argument and expect a string to be returned. Strings are aliases for inbuilt functions for common case conversions. Options include:
dash-case
(default),lisp-case
,spinal-case
,kebab-case
,underscore_case
,snake_case
,camelCase
,CamelCase
. - nullIfMissing: Set the attribute to null if missing from your data input. Default: false.
- pluralizeType: A boolean to indicate if the type must be pluralized or not. Default: true.
- typeForAttribute: A function that maps the attribute (passed as an argument) to the type you want to override. If it returns
undefined
, ignores the flag for that attribute. Option pluralizeType ignored if set. - meta: An object to include non-standard meta-information. Values can be a plain value or a function
- transform: A function to transform each record before the serialization.
Examples
Simple usage:
The result will be something like:
Deserialization
The function JSONAPIDeserializer
takes one argument:
opts
: The deserializer options.
Calling the deserialize
method on the returned object will deserialize your data
(JSONAPI document) to a plain javascript object. Canoscan lide 25 driver mac.
Available deserialization option (opts
argument)
- keyForAttribute: A function or string to customize attributes. Functions are passed the attribute as a single argument and expect a string to be returned. Strings are aliases for inbuilt functions for common case conversions. Options include:
dash-case
(default),lisp-case
,spinal-case
,kebab-case
,underscore_case
,snake_case
,camelCase
,CamelCase
. - AN_ATTRIBUTE_TYPE: this option name corresponds to the type of a relationship from your JSONAPI document.
- valueForRelationship: A function that returns whatever you want for a relationship (see examples below) can return a Promise (see tests)
- transform: A function to transform each record after the deserialization.
Examples
Simple usage:
Relationship:
Notes on Promises
Node Js Install
The deserialization option valueForRelationship
supports returning a Promise
and so this library uses Promises
under the hood. bluebird
was previously used as a dependency, but due to bundle size concerns on both node and the web it was replaced with native promises.
bluebird
is definitely more performant than native Promises. If performance is a major concern Promise
can be globally polyfilled
- node - via
global.Promise = require('bluebird')
- web - global
Promise
automatically gets assigned when using the script tag to loadbluebird
Error serialization
The function JSONAPIError takes one argument:
opts
: The error options. All options are optional.
Available error option (opts
argument)
- id: a unique identifier for this particular occurrence of the problem.
- status: the HTTP status code applicable to this problem, expressed as a string value.
- code: an application-specific error code, expressed as a string value.
- title: a short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail: a human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized.
- source: an object containing references to the source of the error, optionally including any of the following members:
- pointer: a JSON Pointer [RFC6901] to the associated entity in the request document [e.g. '/data' for a primary data object, or '/data/attributes/title' for a specific attribute].
- parameter: a string indicating which URI query parameter caused the error.
- links: a links object containing the following members:
- about: a link that leads to further details about this particular occurrence of the problem.
- meta: a meta object containing non-standard meta-information about the error.
Examples
Node Js Commands
Simple usage:
Node Js Web Server Example
The result will be something like: