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

simple-string-truncate

v1.0.0

Published

A lightweight utility for truncating strings in JavaScript.

Downloads

6

Readme

simple-string-truncate

simple-string-truncate is a lightweight utility for truncating strings in JavaScript. It allows you to dynamically set a length limit and append a custom truncation symbol (e.g., ...) when the string exceeds the specified limit. This package handles various edge cases, ensuring robust performance.

Features

  • Dynamic Truncation: Set custom length limits and truncation symbols.
  • Edge Case Handling: Gracefully handles non-string inputs, short strings, and invalid truncation limits.
  • Lightweight: Minimalistic and efficient, perfect for small to mid-sized projects.

Installation

You can install simple-string-truncate via npm:

npm install simple-string-truncate

Usage

Here’s a simple example of how to use simple-string-truncate:

const truncateString = require('simple-string-truncate');

const longString = 'This is a long string that needs to be truncated';
const shortString = 'Short string';

console.log(truncateString(longString, 20)); // Output: 'This is a long str...'
console.log(truncateString(shortString, 20)); // Output: 'Short string'

Parameters

-- str (string) : The string to be truncated. -- limit (number, optional) : The maximum length of the string before truncation. Default is 50. -- symbol (string, optional) : The symbol to append to the truncated string. Default is ....

Edge Cases

Non-string input : Throws an error. Empty string : Returns an empty string. limit less than the length of symbol : Throws an error. Strings shorter than or equal to limit : Returns the original string without modification.

Example

// Truncate with a custom limit and symbol
const customTruncate = truncateString('Truncate me!', 8, '---');
console.log(customTruncate); // Output: 'Trunca---'

// Handle edge cases
try {
    truncateString(12345, 5); // Non-string input
} catch (error) {
    console.error(error.message); // Output: 'Input must be a string'
}

Contributing

Contributions are welcome! If you find a bug or have a feature request, please open an issue or submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for more details.