I work hard for every project, including this one
and your support means a lot to me!
Consider buying me a coffee. ☕
Thank you for supporting my efforts! 🙏😊
@igorskyflyer
- 🫎 reorders elements randomly
- 🐔 works for strings and arrays
- 🐲 uses
Fisher-Yates
algorithm
Install it by executing:
npm i '@igor.dvlpr/scramble'
Scrambles the characters of each word in a given string.
input
- The string to be scrambled.
Note
Since Fisher-Yates
algorithm is used for scrambling, a length of > 3 is needed for a word to be able to get scrambled.
options
- Options for scrambling, optional.
options
are defined via an interface IStringOptions
:
interface IStringOptions {
trimWhitespace?: boolean
}
trimWhitespace
, if true all whitespace is removed from the input string prior to scrambling its contents.
Returns the scrambled string.
Will throw an error if the input is not a string.
Scrambles the elements of an array.
input
- The array to be scrambled.
Returns the scrambled array.
Will throw an error if the input is not an array.
example.mts
import { scrambleString, scrambleArray } from '@igor.dvlpr/scramble'
// these are just sample outputs
// since each invocation reorders
// elements randomly
console.log(scrambleString(
'Lorem ipsum dolor sit amet, consectetur adipiscing elit.'
)) // returns 'Leorm isupm dloor sit aetm, ccotnsueetr asdincipig eitl.'
console.log(scrambleString(
'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', { trimWhitespace: true }
)) // returns 'Lpetssgerodcsctcmuaunelrteiisoomirlait,toindmipe.'
console.log(scrambleArray([1, 2, 3, 4, 5, 6, 7, 8])) // [5, 7, 1, 4, 2, 8, 3, 6]
📑 The changelog is available here: CHANGELOG.md.
Licensed under the MIT license which is available here, MIT license.
🎉 Provides UArray, an Array type that supports negative indices/indexes, just wrap your regular JavaScript array with UArray() and you are all set! 🙌
🧵 An expressive and chainable library for advanced string manipulations. Supports appending, prepending, trimming, quoting, and path formatting with customizable whitespace handling. Makes advanced String manipulations a piece of cake. 🦥
🥞 Removes HTML code from the given string. Can even extract text-only from the given an HTML string. ✨
🦀 ExtendableString allows you to create strings on steroids that have custom transformations applied to them, unlike common, plain strings. 🪀
✒ DúöScríbî allows you to convert letters with diacritics to regular letters. 🤓
Created by Igor Dimitrijević (@igorskyflyer).