/string-utils

A collection of utilities for JavaScript strings

Primary LanguageJavaScriptApache License 2.0Apache-2.0

string-utils

Build Status codecov npm Bundlephobia minified size

A collection of utilities for JavaScript strings.

Installation

Via npm:

npm install @ultraq/string-utils

API

escapeHtml(string)

Escapes special HTML characters in a string with their entity code equivalents. Returns a string safe to use as text within an HTML document.

  • string: string to escape.

format(template, ...values)

Returns the replacement of each placeholder in a template string with a corresponding replacement value.

  • template: String containing indexed ({0}, {1}, ...) or named ({value}, {greeting}, ...) placeholders, but not both. where n is the corresponding index value to have filled-in.
  • ...values: Either an argument list / array of values to replace values in an indexed template string, or an object where the keys are the names in a named template string to replace with their values.