Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/igorskyflyer/npm-scramble
๐ Scrambles (rearranges randomly) Strings and Arrays. ๐
https://github.com/igorskyflyer/npm-scramble
algorithm array back-end fisher-yates-shuffle igorskyflyer javascript js node random scramble shuffle string ts typescript
Last synced: 8 days ago
JSON representation
๐ Scrambles (rearranges randomly) Strings and Arrays. ๐
- Host: GitHub
- URL: https://github.com/igorskyflyer/npm-scramble
- Owner: igorskyflyer
- License: mit
- Created: 2024-08-03T23:04:00.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-04T20:10:49.000Z (3 months ago)
- Last Synced: 2024-10-05T21:17:05.834Z (about 1 month ago)
- Topics: algorithm, array, back-end, fisher-yates-shuffle, igorskyflyer, javascript, js, node, random, scramble, shuffle, string, ts, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@igor.dvlpr/scramble
- Size: 38.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
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
## ๐ Table of contents
- [Features](#-features)
- [Usage](#-usage)
- [API](#-api)
- [scrambleString()](#scramblestringinput-string-options-istringoptions-string)
- [scrambleArray()](#scramblearrayarraytypeinput-arraytype-arraytype)
- [Examples](#-examples)
- [Changelog](#-changelog)
- [License](#-license)
- [Related](#-related)
- [Author](#-author)
---
## ๐ค Features
- ๐ซ reorders elements randomly
- ๐ works for strings and arrays
- ๐ฒ uses `Fisher-Yates` algorithm
## ๐ต๐ผ Usage
Install it by executing:
```shell
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`:
```ts
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(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`
```ts
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](https://github.com/igorskyflyer/npm-scramble/blob/main/CHANGELOG.md).
---
## ๐ชช License
Licensed under the MIT license which is available here, [MIT license](https://github.com/igorskyflyer/npm-scramble/blob/main/LICENSE).
---
## ๐งฌ Related
[@igor.dvlpr/uarray](https://www.npmjs.com/package/@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](https://www.npmjs.com/package/@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](https://www.npmjs.com/package/@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](https://www.npmjs.com/package/@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](https://www.npmjs.com/package/@igor.dvlpr/duoscribi)
> _โ DรบรถScrรญbรฎ allows you to convert letters with diacritics to regular letters. ๐ค_
---
## ๐จ๐ปโ๐ป Author
Created by **Igor Dimitrijeviฤ** ([*@igorskyflyer*](https://github.com/igorskyflyer/)).