Git Product home page Git Product logo

node-marshal's Introduction

node-marshal

Build Status Code Climate Test Coverage

Parse Ruby's Marshal strings into JavaScript objects/JSON.

This module could not have been built this without this awesome blog post series.

Installation

npm install marshal

Use

Basic use

var Marshal = require('marshal');
var m = new Marshal('0408220a68656c6c6f', 'hex');
console.log(m.parsed); // 'hello'

Decode a Rails cookie

This library was purpose-built for sharing a Rails cookie with an Express session.

See instore/rails-cookie-parser for an example.

Features / Limitations

Able to convert a Marshal string into a JavaScript object (not all types are supported, if you see one you would like supported please create an issue). i.e. Marshal.load()

Unable to convert a JavaScript object into a Marshal string. i.e. Marshal.dump()

Supported Types

  • nil (converted to null)
  • booleans
  • integers
  • bignums
  • raw strings
  • symbols
  • symbol links
  • object links
  • IVARs (encoded strings, regular expressions are not supported)
  • arrays
  • objects
  • hashes

Unsupported Types

Notes

From what I can tell, positive integers are unsigned and negative integers are signed. Thus, positive integers have twice the range as negative integers.

Acknowledgements

The bignum base conversion algorithm was adapted from MikeMcl/decimal.js which is copyright Michael Mclaughlin.

node-marshal's People

Contributors

clayzermk1 avatar

Stargazers

 avatar Nowa Zhu avatar Josh Teneycke avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.