Skip to content

📦 JavaScript implementation of the SuperPack extensible schemaless binary encoding format

License

Notifications You must be signed in to change notification settings

shapesecurity/superpack-js

Repository files navigation

SuperPack (JS)

About

This module provides a transcoder for the SuperPack binary encoding format.

Status

Experimental.

Installation

npm install superpack

Usage

import {encode, decode} from "superpack";
let payload = encode(/* your SuperPack-serialisable value */);
let reconstructedValue = decode(payload);

Contributing

  • Open a Github issue with a description of your desired change. If one exists already, leave a message stating that you are working on it with the date you expect it to be complete.
  • Fork this repo, and clone the forked repo.
  • Install dependencies with npm install.
  • Test in your environment with npm test.
  • Create a feature branch. Make your changes. Add tests.
  • Test in your environment with npm test.
  • Make a commit that includes the text "fixes #XX" where XX is the Github issue.
  • Open a Pull Request on Github.

License

Copyright 2016 Shape Security, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

About

📦 JavaScript implementation of the SuperPack extensible schemaless binary encoding format

Resources

License

Stars

Watchers

Forks

Packages

No packages published