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

@kitmi/types

v1.3.4

Published

JavaScript semantic data types

Downloads

253

Readme

@kitmi/types

JavaScript Semantic Data Types

@kitmi/types defines semantic data types with validation and sanitization.

Installation

To install @kitmi/types, run the following command:

bun install @kitmi/types

Or if you're using npm:

npm install @kitmi/types

Conventions

Types

  • any
  • array
  • bigint
  • binary
  • boolean
  • datetime
  • integer
  • number
  • object
  • text

Type Interface

name: "type name",
alias: ["type alias"],
defaultValue: null,

sanitize: (value, meta, i18n, context) => sanitized,
serialize: (value, meta) => string

Common Type Meta

  • {boolean} plain - Keep raw value, don't try to type cast before post processing
  • {boolean} optional - No error throw if value is null and default is null
  • {any} default - Default value if value is null
  • {array} enum - An array of values which the value of a enumerable type should be one of it

Enumerable Types

  • bigint
  • integer
  • number
  • text

Validation Error

  • message
  • status = 400
  • code = E_INVALID_DATA
  • info = { value, meta, [i18n], [path] }

Plugins

  • datetimeParser
  • bigintWriter
  • preProcess - [sync/async] (value, meta, opts: { rawValue, i18n, path }) => [ finished, processedValue ] or [ false ]
  • postProcess - [sync/async] (value, meta, opts: { rawValue, i18n, path }) => processedValue

Note: if preProcess or postProcess is async function, sanitize_ should be called instead of sanitize

See @kitmi/validators for semantic validation.

Notes

  • Object sanitization

Use keepUnsanitized for keeping those entries not defined in the object schema.

License

  • MIT
  • Copyright (c) 2023 KITMI PTY LTD