npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

tserial

v1.1.2

Published

Runtime validation for TypeScript type expressions

Downloads

29

Readme

tserial

Runtime deserialization for TypeScript interfaces and type aliases

Table of Contents

Overview

Read the blog post for a high level summary

TypeScript's structural typing system offers a powerful way to represent the shape of data. Data delivered across systems is, by default, not validated. A developer version can use type assertions to "cast" untrusted input to the expected type, but this is often done in an insecure way. Developers will usually write code that validates input data and coerces it to the right type.

tserial automates this process and offers a way to securely deserialize data at runtime.

Design Goals

  • Should use plain TypeScript expressions as the source of truth (no DSLs or codecs)
  • Should define a subset of type expressions that represent serializable data. Expressions involving functions (classes, function declarations and expressions, etc) will not be permitted.
  • Should offer consumers a way to opt-in to interfaces/type aliases they would like to be validated at runtime
  • Should generate a single file with a deserialization routine
  • Should have no runtime dependencies
  • Should have minimal build time dependencies
  • Deserialization routine should use composable assertions and type guards which incrementally prove adherence to a type expression via narrowing
    • Hedges against "stale" output since compiler will usually raise errors when narrowing produces an incomplete type
  • Deserialization routine must produce granular error data. If data isn't valid, structured error data should be returned to the caller
  • Node.js, browser, and deno support

Installation

npm install tserial --save-dev

yarn add tserial --dev

Usage

The CLI and Node API use the same underlying modules. Both generate file content. The CLI takes care of writing the file to the file system, while the Node API just returns string content.

In either mode, it's highly recommended to use a formatter like prettier to format the generated code. No attempt has been made to autogenerate well-formatted code.

CLI

# all options
tserial --help

# minimal command, use tsconfig.json at project root and default tag identifier
tserial --out ./path/to/generated_file.ts

# custom tsconfig
tserial --out ./path/to/generated_file.ts --tsconfig some-custom-tsconfig.json

# custom tag name (defaults to serializable)
# custom tsconfig
tserial --out ./path/to/generated_file.ts --tag myCustomTag

# deno imports
tserial --out ./path/to/generated_file.ts --deno

Node API

Check out render-content in renderer tests for an example of how the test suite calls the Node API.

Direct use of the Node API will allow greater flexibility within existing build systems, but the CLI may be faster to start with.