Native Package Manager

    wordscramble

    5.1.21 • Public • Published

    Wordscramble

    Wordscramble is a completely pointless and functionally-programmed Node package which you shouldn't install. The only thing Wordscramble does is scramble JavaScript object values. This is an is-thirteen level of uselessness, although I can boast that my functions are artisanal; they're both pure and free of side-effects.

    On the other hand, Wordscramble is reasonably robust against whatever random crap you throw at it, and it does some cool stuff with recursion to get the job done.

    Badges

    Look at all the shiny badges! Badges mean quality and Wordscramble has four quality. Look at them! Look at them! :)

    Build Status Dependency Status devDependency Status npm version

    Installation

    npm install wordscramble
    

    Usage

    wordscramble.scramble() will attempt to guess the appropriate scramble function for a given variable:

    const wordscramble = require('wordscramble');
    
    wordscramble.scramble(true); // false
    wordscramble.scramble(0.123131231); // 11.32233110
    wordscramble.scramble('heighliner'); // glhenehrii
    wordscramble.scramble({atreides: 'Caladan', corinno: 'Kaitain'}); //{ atreides: 'ladnaCa', corinno: 'anaiKit' }
    wordscramble.scramble(['Atreides', 'Harkonnen', 'Corrino', 'Ginaz']); // [ 'oeannHnkr', 'znaGi', 'estrAedi', 'roirnoC' ]
    

    Scramble methods for a given type may be accessed directly:

    wordscramble.array(['Paul Atreides', 'Alia Atreides', 'Leto Atreides']); // [ 'Alia Atreides', 'Leto Atreides', 'Paul Atreides' ]
    wordscramble.bool(true); // false
    wordscramble.number(10191); // 90111
    wordscramble.object({ spice: 'essential', fremen: 'scary', shaihulud: 'literally god' }); { spice: 'ineslstea', fremen: 'arcys', shaihulud: 'yaol gltrdlei' }
    wordscramble.string('bene gesserit'); // 'ietrbens seeg'
    

    Wordscramle returns a scrambled copy of passed data. Original values are never mutated:

    > const atreides = { dueke: 'Leto', heir: 'Paul' }
    undefined
    > wordscramble.object(atreides)
    { dueke: 'oetL', heir: 'Pual' }
    > atreides
    { dueke: 'Leto', heir: 'Paul' }
    

    Testing

    npm test/test
    

    Contributing

    Go wild! All pull requests are welcome.

    License

    Copyright (c) 2016 [Mark Grealish][10]. See LICENSE for details.

    FAQ

    Why?

    Teeling Single Malt.

    Okay...

    Yeah, look. Like, it was my birthday this weekend and I was gifted a bottle of whiskey. First I drank the whiskey and then I wrote this.

    What's with all the Dune references?

    I'm an unashamed fan for all things Dune and Frank Herbert.

    Install

    npm i wordscramble

    DownloadsWeekly Downloads

    9

    Version

    5.1.21

    License

    MIT

    Last publish

    Collaborators

    • bhalash