Options
All
  • Public
  • Public/Protected
  • All
Menu

@thi.ng/strings

strings

npm versionnpm downloads Twitter Follow

This project is part of the @thi.ng/umbrella monorepo.

About

Various higher-order, configurable string formatting & utility functions, some memoized. Please sources / docstrings for now.

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

Status

STABLE - used in production

Search or submit any issues for this package

Installation

yarn add @thi.ng/strings
// ES module
<script type="module" src="https://unpkg.com/@thi.ng/strings?module" crossorigin></script>

// UMD
<script src="https://unpkg.com/@thi.ng/strings/lib/index.umd.js" crossorigin></script>

Package sizes (gzipped, pre-treeshake): ESM: 2.72 KB / CJS: 2.97 KB / UMD: 2.84 KB

Dependencies

Usage examples

Several demos in this repo's /examples directory are using this package.

A selection:

ScreenshotDescriptionLive demoSource
Basic crypto-currency candle chart with multiple moving averages plotsDemoSource
Basic SPA example with atom-based UI routerDemoSource
rstream based spreadsheet w/ S-expression formula DSLDemoSource
XML/HTML/SVG to hiccup/JS conversionDemoSource

API

Generated API docs

Basic usage examples

// 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)

General

  • defFormat
  • format
  • hstr
  • ignore
  • interpolate
  • str

Case

  • camel
  • capitalize
  • kebab
  • lower
  • snake
  • slugify
  • upper

Numeric & radix-based

  • float
  • floatFixedWidth
  • maybeParseFloat
  • maybeParseInt
  • percent
  • radix
  • uuid
  • B8 / B16 / B32 - binary / bitstring presets
  • U8 / U16 / U24 / U32 / U64 - hex format presets (unsigned values)

Padding / truncation

  • center
  • padLeft
  • padRight
  • truncate
  • truncateLeft
  • wrap
  • Z2 / Z3 / Z4 - zero-pad presets

Units

  • units - define new unit w/ magnitudes & suffixes
  • bits
  • bytes
  • grams
  • meters
  • seconds

String creation & editing

  • charRange
  • repeat
  • splice

Authors

Karsten Schmidt

License

© 2015 - 2020 Karsten Schmidt // Apache Software License 2.0

Generated using TypeDoc