devkit

A tiny npm package for developer-friendly string helpers.

Installation

npm install @devkitlab/devkit
yarn add @devkitlab/devkit
pnpm add @devkitlab/devkit

Usage

const devkit = require("@devkitlab/devkit");
const { pluralize, ordinal, capitalize, truncate, slugify } = require("@devkitlab/devkit");

console.log(devkit.pluralize(1, "item")); // 1 item
console.log(devkit.pluralize(5, "item")); // 5 items

console.log(pluralize(1, "task")); // 1 task
console.log(pluralize(3, "task")); // 3 tasks
console.log(ordinal(21)); // 21st
console.log(capitalize("devkit")); // Devkit
console.log(truncate("developer toolkit", 10)); // develop...
console.log(slugify("Hello DevKit Lab")); // hello-devkit-lab

import devkit, {
  capitalize,
  ordinal,
  pluralize,
  slugify,
  truncate
} from "@devkitlab/devkit";

devkit.pluralize(1, "item"); // "1 item"
pluralize(2, "item"); // "2 items"
ordinal(3); // "3rd"
capitalize("devkit"); // "Devkit"
truncate("developer toolkit", 10); // "develop..."
slugify("Hello DevKit Lab"); // "hello-devkit-lab"

API

pluralize(count, word)

Returns a string with the count and either the singular or plural form of the word.

pluralize(1, "item"); // "1 item"
pluralize(5, "item"); // "5 items"

ordinal(value)

Returns a number with its ordinal suffix.

ordinal(1); // "1st"
ordinal(2); // "2nd"
ordinal(11); // "11th"

capitalize(text)

Uppercases the first character of a string.

capitalize("devkit"); // "Devkit"

truncate(text, length)

Shortens a string and appends ... when needed.

truncate("developer toolkit", 10); // "develop..."

slugify(text)

Converts text into a URL-friendly slug.

slugify("Hello DevKit Lab"); // "hello-devkit-lab"

License

MIT