supercharge / strings

String utilities for Node.js

Strings

String utilities for Node.js.

Installation · Docs · Usage

Follow @marcuspoehls and @superchargejs for updates!

---

Introduction

The @supercharge/strings package provides chainable string utilities for Node.js and JavaScript. It’s a wrapper around JavaScript’s global String class providing a handful of useful methods, like .title(), .strip(), .camel(), and so on.

Installation

npm i @supercharge/strings

Docs

Find all the details for @supercharge/strings in the extensive Supercharge docs.

Usage

Using @supercharge/strings is pretty straightforward. Pass a string to the imported Function and chain your desired methods to transform to string value to your needs.

For example, you may want to trim a string and then title-case it:

import { Str } from '@supercharge/strings'
// or 
const { Str } = require('@supercharge/strings')

const title = Str('  Supercharge is sweet!').trim().title().get()

// title: "Supercharge Is Sweet!"

For every method in the chain that would return a string, the package returns an instance of iteself. This way, you can chain further methods. Call .get() to retrieve the actual JavaScript string.

Contributing

Do you miss a string function? We very much appreciate your contribution! Please send in a pull request 😊

1. Create a fork
2. Create your feature branch: git checkout -b my-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request 🚀

License

MIT © Supercharge

---

superchargejs.com  ·  GitHub @supercharge  ·  Twitter @superchargejs

strings's Issues

Add "padLeft" method

Add a new .padLeft(length, pad) method that pads the current string with another string (multiple times, if needed) until the resulting string reaches the given length. The padding is applied from the start of the current string.

Example

Str('Marcus').padLeft(10, '.').get()
// '....Marcus'

Add "prepend" method

Add a new .prepend(...values) method that prepends the given values onto the string:

Example

Str('awesome').prepend('Supercharge ', 'is ').get()

// 'Supercharge is awesome'

Add "limit" method

The str.limit(limit, end = '…') method returns the first limit characters and ends the limited string with end.

Example

Str('Supercharge').limit(5, ' ->').get()

// 'Super ->'

Add "kebab", "snake", "pascal" methods

I want to propose to add new methods: kebab(), snake(), pascal()

Example

Str('Supercharge kebab case').kebab().get()
// 'supercharge-kebab-case'

Str('Supercharge snake case').snake().get()
// 'supercharge_snake_case'

Str('Supercharge pascal case').pascal().get()
// 'SuperchargePascalCase'

Reference: https://medium.com/better-programming/string-case-styles-camel-pascal-snake-and-kebab-case-981407998841

Add "endsWith" method

The str.endsWith(needle) method determines whether a string ends with the given needle.

Example

Str('Supercharge is awesome').endsWith('some')

// true

Str('Supercharge is awesome').endsWith('Super')

// false

Add "replace" method

Add a new .replace(search, replace) method that replaces the first occurrence of the given search value with the replacing value.

Example

Str('Supercharge is nice').replace('nice', 'sweet').get()

// 'Supercharge is sweet'

`Str.pascal()` method ignores uppercases on the middle of words

import Str from '@supercharge/strings';

Str('thisIsInCamelCase').pascal().get(); // returns 'Thisisincamelcase'. It should be 'ThisIsInCamelCase'

Add Method: equalsIgnoreCase

Hello, I think a useful method to add would be one that checks for equality while ignoring the character cases. This would be called something like equalsIgnoreCase

Some examples:

Str('SUPERCHARGE').equalsIgnoreCase('supercharge') //true
Str('SuPeRcHaRgE').equalsIgnoreCase('sUpErChArGe') //true
Str('SUPERCHARGE').equalsIgnoreCase('SLOWCHARGE') //false
Str('SuPeR').equalsIgnoreCase('sUpErChArGe') //false

If this sounds good I'd love to create a PR

Limit string by number of words

Is there a way to limit a string by the number of words? I tried a few ways to get at it.

Str("To be or not to be").words().limit(3).get()

I'm doing it right now with:

Str(text).words().slice(0,5).join(" ") + "...

Add "startsWith" method

The str.startsWith(needle) method determines whether a string starts with the given needle.

Example

Str('Supercharge').startsWith('Super')

// true

Str('Supercharge').startsWith('super')

// false

Add "append" method

Add a new .append(...values) method that appends the given values to the string:

Example

Str('Supercharge').append(' is', ' awesome').get()

// 'Supercharge is awesome'

Confusion with "Str" Class Constructor

Could you please explain why you used an || statement with empty quotes in the constructor? Couldn't you just "slice" it?

strings/src/str.js

Line 17 in 6abd687

this.value = String(value || '').slice(0)

Add method: at

Implement an at method that returns the character at a given index.

Requirements

• please follow the proposal for an at` method
• please use the prepared method-at branch (contains tests)
• make sure the automated tests pass

Add "padRight" method

Add a new .padRight(length, pad) method that pads the current string with a given string (repeated, if needed) so that the resulting string reaches a given length. The padding is applied from the end of the current string.

Example

Str('Marcus').padRight(10, '.').get()
// 'Marcus....'

Add replaceLast Method

The search method returns the position of the first occurrence of a specified text in a string

@marcuspoehls can you assign this to me and add label as hactoberfest.

Add "finish" method

Add a new .finish(suffix) method that adds a single instance of the given suffix value to the end of the string if it doesn’t already ends with the given suffix.

Example

Str('https://github.com').finish('/').get()
// 'https://github.com/'

Str('https://github.com/').finish('/').get()
// 'https://github.com/'

Add "ucFirst" method

The str.ucFirst() method uppercases the first character of the string.

Example

Str('superCHARGE').ucFirst().get()

// 'SuperCHARGE'

Add method: isCamelCase

Hey! What about adding a new method to check whether a given string is written in CamelCase or not? This should work with a simple Regex like: /^[a-z]+([A-Z][a-z]+)+$/g.

Examples:

Str("helloWorld").isCamelCase() // true
Str("helloWOrld").isCamelCase() // false
Str("hello").isCamelCase() // false
Str("hellO").isCamelCase() // false
Str("Hello").isCamelCase() // false

If that's okay I would like to submit a PR :)

Add "start" method

Add a new .start(prefix) method that prepends a single instance of the given prefix value to the start of the string if it doesn’t already start with the given prefix.

Example

Str('repos/supercharge').start('/').get()
// '/repos/supercharge'

Str('/repos/supercharge').start('/').get()
// '/repos/supercharge'

Str.random(length) not working

I am using random function to generate a token as shown in the code below
const Str=require('@supercharge/strings); const token = Str.random(50);
but its giving me the error
TypeError: Str.random is not a function
The same code was working when i used it some months before.
Is random function is removed ?

Add "afterLast" method

Add a new .afterLast(delimiter) method that returns everything from the string after the last occurrence of the given delimiter. This method returns the entire string if the delimiter doesn’t exist in the string.

Example

Str('Supercharge-is-awesome').afterLast('-').get()

// 'awesome'

Add method: isUuid

Implement an isUuid method that returns true if the wrapped string value is a valid UUID. Returns false otherwise

Requirements

• we already use the uuid package that exposes a validate function. You may reuse the available helper function
• please use the prepared method-is-uuid branch (contains tests)
• make sure the automated tests pass

Add "trimStart" method

The str.trimStart() method removes all whitespace at the beginning of a string.
Example

Str('    Supercharge  ').trimStart().get()

// 'Supercharge  '

Add method: isSymbol

Implement a static isSymbol method that returns true if the given value is a JavaScript Symbol. Returns false otherwise.

Requirements

• please use the prepared method-is-symbol branch (contains tests and extended interfaces)
• make sure the automated tests pass

Add "concat" method

The str.concat(addon) method appends the given addon to the string.

Example

const str = Str('Supercharge').concat('is awesome').get()

// 'Supercharge is awesome'

Add "substr" method

The str.substr(start, length) method returns the substring of length length starting from position start.

Example

Str('Supercharge').substr(0, 5).get()

// 'Super'

Add "split" method

The str.split(separator) splits the string at the given separator and returns an array of all separated strings.

Example

Str('Supercharge-is-awesome!').split('-')

// [ 'Supercharge', 'is', 'awesome!' ]

Add "trimEnd" method

The str.trimEnd() method removes all whitespace at the end of a string.

Example

Str('  Supercharge     ').trimEnd().get()

// '  Supercharge'

Add "beforeLast" method

Add a new .beforeLast(delimiter) method that returns everything from the string before the last occurrence of the given delimiter. This method returns the entire string if the delimiter doesn’t exist in the string.

Example

Str('Supercharge-is-awesome').beforeLast('-').get()

// 'Supercharge-is'