@types/omgopass

Installation

npm install --save @types/omgopass

Summary

This package contains type definitions for omgopass (https://github.com/omgovich/omgopass#readme).

Details

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

index.d.ts

interface OmgopassOptions {
    /**
     * Count of syllables
     * @default 3
     */
    syllablesCount?: number | undefined;
    /**
     * Minimal length of a syllable
     * @default 2
     */
    minSyllableLength?: number | undefined;
    /**
     * Max length of a syllable
     * @default 3
     */
    maxSyllableLength?: number | undefined;
    /**
     * Put numbers in the password
     * @default true
     */
    hasNumbers?: boolean | undefined;
    /**
     * Use titlecase
     * @default true
     */
    titlecased?: boolean | undefined;
    /**
     * Vowel alphabet
     * @default 'aeiouy'
     */
    vowels?: string | undefined;
    /**
     * Consonant alphabet
     * @default 'bcdfghklmnprstvz'
     */
    consonants?: string | undefined;
    /**
     * Symbols that separate syllables
     * @default ''
     */
    separators?: string | undefined;
}

declare function omgopass(options?: OmgopassOptions): string;

export = omgopass;

Additional Details

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

Credits

These definitions were written by Nikolai Kolodziej.