npm.io
0.1.2 • Published 2 years ago

@types/hyggedyne__scrabbleify

Licence
MIT
Version
0.1.2
Deps
0
Size
4 kB
Vulns
0
Weekly
0
Stars
51.4K

Installation

npm install --save @types/hyggedyne__scrabbleify

Summary

This package contains type definitions for @hyggedyne/scrabbleify (https://github.com/relativityboy/scrabbleify#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/hyggedyne__scrabbleify.

index.d.ts

/**
 * Scrabbleify words (mix letters within words and output the result)
 *
 * Supports mixing characters within words.
 * Respects the position of inviolates like basic punctuation and numbers. (customizable) 1234567890, ,'".;: and \~!@#$%^&*()_+{}[]|
 *
 * @param inputString - input words
 * @param separator - By default separator is a ' ' but can use one or more custom separators.
 */
export function scrabbleify(
    inputString: string,
    separator?: string | string[],
    inviolates?: boolean | string[],
): string;

export const numbers: string[];

export const punctuation: string[];

export const symbols: string[];

Additional Details

  • Last updated: Tue, 07 Nov 2023 0337 GMT
  • Dependencies: none

Credits

These definitions were written by Piotr Błażejewicz.