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

@prelude-io/core

v1.6.4

Published

Type-save runtime IO library based on PreludeTS

Downloads

233

Readme

Prelude-IO

npm version documentation

This library aims to provide easy to use run- and compiletime type-safety combined with the benefits of immutability through Prelude-ts.

Interop with Prelude-ts is a key feature of this library, but not strictly required for operation.

Core library

Prelude-IO's base unit is the Bus<I, O> class, which provides basic functionality and abstractions around creating reversible data pipelines. The core library also includes a few basic types to represent most data formats, found here under Presets.

Examples can be found here. Alternatively, here's an overview of some basic functionality:

import * as io from "prelude-io";
import { Predicate } from "prelude-ts";

// Conditional types
const rating = io.number.if(Predicate.of((n) => n > 0 && n <= 5));

// Complex types
const roomType = io.Complex("Room", {
  name: io.string.
  description: io.Optional(io.string),
  rating: rating,
});

// Nesting
const hotelType = io.Complex("Hotel", {
  address: io.string,
  website: io.string,
  rating: rating
  rooms: io.Vector(Room)
});

// Deserialising
fetch("http://example.com/hotels.json")
  .then(response => response.json())
  // (de)serialising
  .then(HotelType.deserialise)
  .then(hotel => {
    // Either-based error handling
    if(hotel.isLeft()) {
      // Built-in debugger
      console.error(io.humanizeErrors(hotel.getLeft()))
    } else {
      LocalStorage.setItem("hotel", hotel.get())
    }
  });

Documentation

You can read typedoc documentation here

Installation

npm install --save @prelude-io/core prelude-ts

Principles

  • Busses split parsing and conditional logic into seperate functions
  • IO returns Either objects rather than throw exceptions
  • Functions can be chained or turned into a union

Additional libraries

Roadmap

  • Add extra commonly used types
  • @prelude-io/test: A set of functions to run basic tests on your data types

Inspirations

  • Prelude-ts: Provides functional programming concepts in an accessible manner. Though a similar name, this project is not directly affiliated with prelude-ts or its authors.
  • io-ts: Runtime type checking, encoding and decoding, based on fp-ts.