Teacake

Teacake is a Typescript Library for simple object de/serialisation. It is strongly inspired by the Python library Marshmallow.

The goal is to provide a simple way of:

• loading data from an external or serialised source, and validating / coercing it into an expected shape.
• dumping and serialising javascript objects in a consistent way, for onward

Simple Example

You can install teacake using your preferred package manager:

• npm install teacake
• yarn add teacake

To get going, simply create a schema and pass data to it's load or dump methods. For example:

import { Schema, Fields } from "teacake";

// First, create a schema for the data you want to load / dump
const schema = new Schema({
  name: Fields.String(missing="Anonymous"),
  age: Fields.Number()
  adminUser: Fields.Bool(missing=false)
});

// Then, load your data
const loaded = schema.load({
  name: "Mike Curtis",
  age: 18,
  adminUser: true,
});
// { name: "Mike Curtis", age: 18, adminUser: true }

// Fields have options that allow for coercion, default setting and validation
const loaded2 = schema.load({
  age: '18',
});
// { name: "Anonymous", age: 18, adminUser: false }

Api Reference

See here for full teacake's full API reference and guide.

Development Philosophy

This development goals of this are library:

• Prioritise readbility and simplicity
• Then, prioritise remaining as lightweight as possible
• Then priotise minimising external dependencies

License

This project is licensed under the MIT License - see the LICENSE file for details.