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

valiload

v0.4.0

Published

A simple and lightweight library for overloading functions in TypeScript.

Downloads

7

Readme

valiload

A simple and lightweight library for overloading functions in TypeScript.

中文版本

What is valiload?

valiload is a TypeScript library that allows you to create functions that can be overloaded with different argument schemas. It provides a convenient way to define multiple versions of a function that can handle different types and combinations of arguments.

valiload means "validate/valibot" + "overload".

Usage

To use valiload, follow these steps:

  1. Install valiload as a dependency in your project:
npm install valiload valibot
  1. Import valiload into your TypeScript file:
import * as v from 'valiload';
  1. Define your overloaded function using the valiload syntax:
const MailSchema = v.object({
  to: v.pipe(
    v.string(),
    v.trim(),
    v.email()
  ),
  subject: v.string(),
  body: v.string(),
});

const overloadedFn = v.valiload()
  .overload([v.string(), v.number()], (a, b) => {
   // Function implementation for string and number arguments
  })
  .overload([v.number(), v.string()], (a, b) => {
   // Function implementation for number and string arguments
  })
  .overload([MailSchema], (mail) => {
   // Function implementation for MailSchema arguments
  });

const overloadedWithFallback = v
  .valiload(() => {
    // Fallback function implementation
  })
  .overload([v.string(), v.number()], (a, b) => {
   // Function implementation for string and number arguments
  });
  1. Call the overloaded function with the appropriate arguments:
overloadedFn("hello", 123); // Calls the first overload
overloadedFn(123, "hello"); // Calls the second overload
overloadedFn({ to: "[email protected]", subject: "Hello", body: "World" }); // Calls the third overload

overloadedWithFallback("hello", 123); // Calls the first overload
overloadedWithFallback(123, "hello"); // Calls the fallback function

The function will execute the implementation that matches the types and order of the arguments.

  1. Enjoy the flexibility of overloaded functions in TypeScript!

For more information on how to define schemas and handle different argument types, refer to the valibot documentation, and for more examples, check out the test or examples in the valiload repository.