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

@produck/mold

v0.3.1

Published

For helping to create a final options from a defined specification.

Downloads

5

Readme

@produck/mold

GitHub Workflow Status Coveralls npm (scoped) npm lerna NPM

A tool module for defining data type schemas to a normalize function. It published as a "Dual CommonJS/ES module" package but ESM first. It is very simple, flexible and extensible.

There is also some default "Catcher". It is helping to throw a "TypeError" with good readability messages. It can be also defined a completely custom catcher to handle the cause if a bad value provided.

It can work in "node.js" and browsers. It is also very friendly with "tree shaking", using "Rollup" so try ESM.

Installation

$ npm install @produck/mold

Examples

The "options" in fs.appendFile(path, data[, options], callback),

import { S, C, P, Normalizer } from '@produck/mold';

const flags = [
	'a', 'ax', 'a+', 'ax+', 'as', 'as+',
	'r', 'r+', 'rs+',
	'w', 'wx', 'w+', 'wx+'
];

const schema = S.Object({
	encoding: P.OrNull(P.String('utf-8')),
	mode: P.Integer(0o666),
	flag: P.Enum(flags);
});

const normalize = Normalizer(schema);

normalize(); // ok
normalize({ encoding: 'utf-8' }); // ok
normalize({ encoding: 123 }); // throws
normalize({ flag: 'f' }); // throws

Usage

Import & Require

As esModule,

import {
	Simplex, Simp, S,
	Compound, Comp, C,
	Preset, Pre, P,
	Normalizer, Circular, Custom,
	Catcher
} from '@produck/mold';
// Or
import * as Mold from '@produck/mold';

// Your code...

As CommonJS,

const {
	Simplex, Simp, S,
	Compound, Comp, C,
	Preset, Pre, P,
	Normalizer, Circular, Custom,
	Catcher
} = require('@produck/mold');
// Or
const Mold = require('@produck/mold');

// Your code...

Creating a normalize() from schema

import { S, P, Normalizer } from '@produck/mold';

const OptionsSchema = S.Object({
	foo: P.String('bar')
});

const normalize = Normalizer(OptionsSchema);

const finalOptions = normalize();

Custom Simplex Value Schema

import { Simplex } from '@produck/mold';
import net from 'node:net';

// A optional schema.
const IPv4 = Simplex.Value(net.isIPv4, 'IP string', () => '0.0.0.0');

// A required schmea
const IPv4 = Simplex.Value(net.isIPv4, 'IP string');

Circular Schema

Custom Proxy Schema

API by Levels

L0 - Manual Functions as Schemas

const l0 = (_value, _empty) => {
	// Some statement...
}

L1 - Simplex Schemas

import { S, Simp, Simplex } from '@produck/mold';

Simplex.Value();
Simplex.Object();
Simplex.Array();
Simplex.Tuple();

L2 - Compound Schemas

import { C, Comp, Compound } from '@produck/mold';

Compound.Not();
Compound.And();
Compound.Or();
Compound.If();

L3 - Special Proxy Schemas

import { Circular, Custom } from '@produck/mold';

Circular();
Custom();

L4 - Preset Schemas & Schema Providers

import { P, Pre, Preset } from '@produck/mold';

Preset.Constant();
Preset.Enum();
Preset.Null;
Preset.NotNull;
Preset.Instance();
Preset.OrNull();
Preset.Number();
...

Best Practices

License

MIT