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

text-table-fast

v0.1.0

Published

Generates borderless text table strings suitable for printing to stdout. Fast. ๐Ÿ

Downloads

5

Readme

Usage

npm i text-table-fast
import { textTable } from "text-table-fast";

console.log(
	textTable([
		["main", "0123456789abcdef"],
		["staging", "fedcba9876543210"],
	]),
);
main     0123456789abcdef
staging  fedcba9876543210

textTable takes in an array of arrays containing strings, numbers, or other printable values.

Options

text-table-fast's textTable can take in an optional second parameter as an object with options

๐Ÿ”„ These options are equivalent to text-table's options, but with expanded names.

align

  • Default: []
  • Type: ("center" | "left" | "right")[]

The alignment for columns, in order. These each default to "left".

import { textTable } from "text-table-fast";

console.log(
	textTable(
		[
			["abc", "abcd", "ab"],
			[1234, 12, 1234],
		],
		{
			alignment: ["left", "center", "right"],
		},
	),
);
abc  abcd  abc
1234  12  1234

horizontalSeparator

  • Default: " "
  • Type: string

Characters to put between each column.

import { textTable } from "text-table-fast";

console.log(
	textTable(
		[
			["abc", "abcd", "ab"],
			[1234, 12, 1234],
		],
		{
			horizontalSeparator: " | ",
		},
	),
);
abc  | abcd |  abc
1234 |  12  | 1234

stringLength

  • Default: (value) => String(value).length
  • Type: (value: string) => number

How to compute the length of strings, such as for stripping ANSI characters.

import color from "cli-color";
import { textTable } from "text-table-fast";

console.log(
	textTable(
		[
			[color.red("abc"), color.blue("def")],
			[12, 34],
		],
		{
			stringLength: (value) => color.strip(value).length,
		},
	),
);
\x1B[31mabc\x1B[39m  \x1B[34mdef\x1B[39m
12  34

Comparison to text-table

text-table-fast has three advantages over text-table:

  • It is fast in almost all scenarios, and significantly faster on larger tables.
  • It is under active maintenance, whereas text-table hasn't been updated in over a decade.
  • It's written in TypeScript and ships with its own .d.ts types, whereas text-table requires @types/text-table for typings.

Performance Comparison

text-table-fast contains two meaningful optimizations over text-table:

  • text-table includes usage of of an quadratically expensive /\s+$/; text-table-fast uses String.prototype.trimEnd instead.
  • text-table executes a regular expression match on each row cell for its '.' (decimal) alignment option; text-table-fast will skip that match if and when decimal alignment support is added.

ESLint issue to be filed soon with a performance comparison. โšก๏ธ

Contributors

Acknowledgements

This package is a near-drop-in replacement for venerable text-table, which has served a plethora of projects -including ESLint- well for over a decade. Many thanks to substack for creating the original text-table package! ๐Ÿ’–

๐Ÿ’™ This package was templated with create-typescript-app.