Package Exports

@igor.dvlpr/scramble
@igor.dvlpr/scramble/dist/index.mjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@igor.dvlpr/scramble) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

ScRaMbLe

🃏 Scrambles (rearranges randomly) Strings and Arrays. 🎋

💖 Support further development
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

🤖 Features

🫎 reorders elements randomly
🐔 works for strings and arrays
🐲 uses Fisher-Yates algorithm

🕵🏼 Usage

Install it by executing:

npm i '@igor.dvlpr/scramble'

🤹🏼 API

`scrambleString(input: string, options?: IStringOptions): string`

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.

`scrambleArray<ArrayType>(input: ArrayType[]): ArrayType[]`

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.

✨ Examples

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]

📝 Changelog

📑 The changelog is available here: CHANGELOG.md.

🪪 License

Licensed under the MIT license which is available here, MIT license.

@igor.dvlpr/uarray

🎉 Provides UArray, an Array type that supports negative indices/indexes, just wrap your regular JavaScript array with UArray() and you are all set! 🙌

@igor.dvlpr/magic-string

🧵 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. 🦥

@igor.dvlpr/strip-html

🥞 Removes HTML code from the given string. Can even extract text-only from the given an HTML string. ✨

@igor.dvlpr/extendable-string

🦀 ExtendableString allows you to create strings on steroids that have custom transformations applied to them, unlike common, plain strings. 🪀

@igor.dvlpr/duoscribi

✒ DúöScríbî allows you to convert letters with diacritics to regular letters. 🤓

👨🏻‍💻 Author

Created by Igor Dimitrijević (@igorskyflyer).

@igor.dvlpr/scramble