Skip to content

bufferpunk/solidtypes

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@bufferpunk/solidtypes

JS/TS value objects for typed input validation.

Features

  • Minimal, dependency-free classes for validating data inputs.
  • Works in JavaScript and TypeScript; exports small, focused APIs.

Installation

npm install @bufferpunk/solidtypes

Quick Examples

Email

import { Email } from '@bufferpunk/solidtypes';

const e = new Email('alice@example.com');
console.log(e.toString());      // 'alice@example.com'
console.log(e.local);          // 'alice'
console.log(e.domain);         // 'example.com'
console.log(Email.isValid('x@x.com')); // true

API

... to be documented

TypeScript

Types are exported so you can use them in TypeScript projects. Example:

import { Url, type UrlOptions } from '@bufferpunk/solidtypes';

const opts: UrlOptions = { protocols: ['https:'], requirePath: true };
if (Url.isValid('https://example.com/a', opts)) {
	const u = new Url('https://example.com/a', opts);
}

Contributing

We're encouraging Contributions, to enrich the types and library. Add types that the library is missing and send a PR. Thank you.

License

MIT

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors