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

@playform/pipe

v0.1.1

Published

🧪 Pipe —

Downloads

74,100

Readme

🧪 Pipe

Pipe allows you to process files in a pipeline, making it easy to perform various operations on them.

🚀 Installation

To get started with Pipe, follow these steps:

Install the Pipe package using npm:

npm install -D -E @playform/pipe

Create a new Pipe instance:

Main.ts

await new (await import("@playform/pipe")).default().In("./Input");

Getting started

With Pipe, you can use the Pipe method to perform operations on files within the pipe. Here's an example of how to do it with some file writes:

Main.ts

await(
	await(
		await new (await import("@playform/pipe")).default().In("./Input"),
	).By("**/*.md"),
).Pipe({
	// Append some content to all of the text files
	Wrote: (On) => (On.Buffer += "LICENSE [MIT]"),
});

Default Callbacks

Pipe provides default callbacks for file processing. These callbacks can be customized to suit your specific needs. Here are the default callbacks:

await new (await import("@playform/pipe")).default().Pipe({
	// Read the file into a buffer
	Read: async ({ Input }) => await fs.promises.readFile(Input, "utf-8"),

	// Wrote the buffer into a file
	Wrote: async ({ Buffer }) => Buffer,

	// Passed the file through a check
	Passed: async (On) => On && true,

	// Failed processing the file
	Failed: async ({ Input }) => `Error: Cannot process file ${Input}!`,

	// Accomplished processing the file
	Accomplished: async ({ Input, Output }) =>
		`Processed ${Input} in ${Output}.`,

	// Fulfilled the whole plan
	Fulfilled: async ({ File }) =>
		`Successfully processed a total of ${File} ${
			File === 1 ? "file" : "files"
		}.`,

	// Changed the plan
	Changed: async (Plan) => Plan,
});

Add Multiple Paths

You can add multiple paths to your pipe by specifying an array as the Path variable:

Main.ts

await new (await import("@playform/pipe")).default().In([
	"./Input",
	"./Input2",
]);

Input-Output Mapping

Pipe will allow you to provide a map of paths for different input and output directories, making it easy to control where files are read from and written to:

Main.ts

await new (await import("@playform/pipe")).default().In(
	new Map([["./Input", "./Output"]]),
);

File Filtering

You can filter files to exclude specific ones from your Pipe. Filters can be an array of regular expressions or a single match. You can also use functions to match on file names:

Main.ts

await new (await import("@playform/pipe")).default().Not([
	"File.txt",
	(File: string) => File === "./Input/File.txt",
]);

Controlling Logging

You can control the logging level by setting the Logger parameter. The default value is 2, but you can set it to 0 if you don't want to see debug messages:

Main.ts

new (await import("@playform/pipe")).default(0);

Changelog

See CHANGELOG.md for a history of changes to this component.