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

@ayte/archetype.function

v0.2.0

Published

Function-related basic types, part of @ayte/archetype

Downloads

3

Readme

Ayte / TypeScript / Archetype / Function

npm CircleCI

This package contains function-related types, mostly modeled after Java types of same purpose. While many people would be more comfortable with standard (x: A, y: B) => C syntax, i find it easier to use IBiFunction<A, B, C> instead.

Installation

yarn add @ayte/archetype.function

# - or -

npm install -S @ayte/archetype.function

Structure

There are five base types: function, predicate, consumer, supplier and runnable. Function, predicate and consumer come in three variants (I<Name>, IBi<Name>, ITri<Name>), while supplier and consumer also have async counterparts (IAsync<Name>).

Function is something that takes N parameters and returns a result:

type IFunction<T, U> = (value: T) => U;
type IBiFunction<T, U, V> = (alpha: T, beta: U) => V;
type ITriFunction<T, U, V, W> = (alpha: T, beta: U, gamma: V) => W;

Predicate is a special "arbiter" type, which takes N parameters and returns a boolean. While generally it's function subtype, it is not expressed as typed function (though TypeScript won't make any difference).

type IPredicate<T> = (value: T) => boolean;
type IBiPredicate<T, U> = (alpha: T, beta: U) => boolean;
type ITriPredicate<T, U, V> = (alpha: T, beta: U, gamma: V) => boolean;

Consumer is a side-effect function that takes in N parameters and doesn't return anything.

type IConsumer<T> = (value: T) => void;
type IBiConsumer<T, U> = (alpha: T, beta: U) => void;
type ITriConsumer<T, U, V> = (alpha: T, beta: U, gamma: V) => void;

Consumer has asynchronous counterparts.

type IAsyncConsumer<T> = (value: T) => Promise<void>;
type IAsyncBiConsumer<T, U> = (alpha: T, beta: U) => Promise<void>;
type IAsyncTriConsumer<T, U, V> = (alpha: T, beta: U, gamma: V) => Promise<void>;

Supplier is a factory that takes nothing and returns some value. It may be useful for generators or simple factories that produce new object instance each call.

type ISupplier<T> = () => T;
type IAsyncSupplier<T> = () => Promise<T>;

Finally, runnable is just a callback that takes nothing and returns nothing as well.

type IRunnable = () => void;

Licensing

MIT / UPL-1.0

Ayte Labs, 2020