npm.io
3.12.8 • Published 3 weeks ago

@thi.ng/strings

Licence
Apache-2.0
Version
3.12.8
Deps
4
Size
86 kB
Vulns
0
Weekly
0
SummaryDependencyVersions

@thi.ng/strings

npm version npm downloads Mastodon Follow

This is one of 216 standalone projects. LLM-free, human-made and cared for software, maintained as part of the @thi.ng/umbrella ecosystem and anti-framework.

Please help me to work full-time on these projects by sponsoring me. Thank you!

About

Collection of ~115 string utilities for formatting, interpolation, word wrapping, validation, case conversion etc. Most of them are configurable higher-order functions, some memoized.

Partially based on Clojure version of thi.ng/strf.

General

  • defFormat / format
  • interpolate / interpolateKeys
  • escape / unescape
  • join / splice / split
  • repeat
  • stringify
  • balance
Numeric formatters
  • currency / chf / eur / gpb / usd / yen
  • radix
  • int / intLocale
  • float / floatFixedWidth
  • maybeParseFloat / maybeParseInt
  • percent
  • uuid
  • vector
  • B8 / B16 / B32 - fixed size binary formatters
  • U8 / U16 / U24 / U32 / U64 - fixed size hex formatters
  • Z2 / Z3 / Z4 - fixed sized zero padded number formatters
Casing
  • lower / upper / capitalize
  • camel / kebab / snake / upperSnake
Slugify
  • slugify / slugifyGH
ANSI
  • isAnsi / isAnsiEnd / isAnsiStart
  • stripAnsi
  • lengthAnsi
Word wrapping
  • wordWrap / wordWrapLine / wordWrapLines
  • SPLIT_PLAIN / SPLIT_ANSI
Padding / wrapping
  • center
  • padLeft / padRight
  • truncate / truncateLeft / truncateRight
  • trim
  • wrap
Indentation
  • spacesToTabs / spacesToTabsLine
  • tabsToSpaces / tabsToSpacesLine
Char range presets / lookup tables
  • charRange
  • ALPHA / ALPHA_NUM / DIGITS / LOWER / UPPER / HEX
  • BOM / ESCAPES / ESCAPES_REV
  • WS / PUNCTUATION
Units
  • units
  • bits / bytes
  • grams
  • meters
  • seconds
  • ruler / grid
Miscellaneous

Status

STABLE - used in production

Search or submit any issues for this package

Installation

yarn add @thi.ng/strings

ESM import:

import * as str from "@thi.ng/strings";

Browser ESM import:

<script type="module" src="https://esm.run/@thi.ng/strings"></script>

JSDelivr documentation

For Node.js REPL:

const str = await import("@thi.ng/strings");

Package sizes (brotli'd, pre-treeshake): ESM: 5.76 KB

Dependencies

Note: @thi.ng/api is in most cases a type-only import (not used at runtime)

Usage examples

Eight projects in this repo's /examples directory are using this package:

Screenshot Description Live demo Source
ASCII art raymarching with thi.ng/shader-ast & thi.ng/text-canvas Demo Source
Large ASCII font text generator using @thi.ng/rdom Demo Source
Basic crypto-currency candle chart with multiple moving averages plots Demo Source
Basic SPA example with atom-based UI router Demo Source
Mastodon API feed reader with support for different media types, fullscreen media modal, HTML rewriting Demo Source
Generative audio synth offline renderer and WAV file export Demo Source
rstream based spreadsheet w/ S-expression formula DSL Demo Source
XML/HTML/SVG to hiccup/JS conversion Demo Source

API

Generated API docs

Basic usage examples
import { defFormat, float, percent } from "@thi.ng/strings";

// create a custom string formatter
const fmt = defFormat([
    "Price: ",
    { usd: "$", gbp: "£", eur: "€" },
    float(2),
    " (",
    percent(2),
    " off)"
]);

// use format
fmt("usd", 1.2345, 0.5);
// Price: $1.23 (50.00% off)

fmt("eur", 1.2345, 0.25)
// Price: €1.23 (25.00% off)

Authors

If this project contributes to an academic publication, please cite it as:

@misc{thing-strings,
  title = "@thi.ng/strings",
  author = "Karsten Schmidt",
  note = "https://thi.ng/strings",
  year = 2015
}

License

2015 - 2026 Karsten Schmidt // Apache License 2.0

Keywords

ansibalancecompositionconversioncursorescapefloatformatfunctionalhexhollerithinterpolationnumberpaddingpercentradixslugifysplitstringtabtexttrimtypescriptunicodeutf8validatewordwrap