@joyful/pipe

A JavaScript/TypeScript utility for function composition that allows you to pipe values through a series of functions.

Installation

# npm
npm install @joyful-tools/pipe

# pnpm
pnpm add @joyful-tools/pipe

# bun
bun add @joyful-tools/pipe

# npm (from JSR)
npx jsr add @joyful/pipe

# pnpm 10.9+ (from JSR)
pnpm add jsr:@joyful/pipe

# yarn 4.9+ (from JSR)
yarn add jsr:@joyful/pipe

# deno
deno add jsr:@joyful/pipe

The examples below use @joyful/pipe (the JSR name) in imports. If you installed from npm, use @joyful-tools/pipe instead.

Usage

The pipe function takes a value and a series of functions, applying each function to the result of the previous one.

import { pipe } from "@joyful/pipe";

const double = (x: number) => x * 2;
const square = (x: number) => x * x;
const addFive = (x: number) => x + 5;

// Basic usage
const result = pipe(4, double, square, addFive);
// result = 69
// Explanation: 4 → double(4) = 8 → square(8) = 64 → addFive(64) = 69

API Reference

pipe(value, ...functions)

Parameters:

• value: T - The initial value to pipe through the functions
• ...functions: ((value: T) => U)[] - Functions to apply in sequence

Returns:

• The final result after applying all functions

Example

String Processing

const trim = (s: string) => s.trim();
const toUpperCase = (s: string) => s.toUpperCase();
const addExclamation = (s: string) => s + "!";

const result = pipe("  hello world  ", trim, toUpperCase, addExclamation);
// result = "HELLO WORLD!"

Benefits

• Type Safety: Full TypeScript support with proper type inference
• Readability: Left-to-right function composition is easier to read than nested function calls
• Immutability: Creates new values without mutating the original
• Composable: Easy to create reusable function pipelines

License

MIT