# @types/omgopass

> TypeScript definitions for omgopass

Latest version **3.2.3** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/omgopass
pnpm add @types/omgopass
yarn add @types/omgopass
bun add @types/omgopass
```

## Health

**Score 40/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 3.2.3 |
| Published | 2023-11-07 |
| First published | 2021-06-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51420 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/omgopass
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/omgopass
- npm.io page: https://npm.io/package/@types/omgopass

## Recent versions

- 3.2.3 (latest) — 2023-11-07
- 3.2.1 (ts3.6) — 2021-07-08
- 3.2.2 — 2023-10-18
- 3.2.0 — 2021-06-08

## README

# 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](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/omgopass/index.d.ts)
````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 09:09:39 GMT
 * Dependencies: none

# Credits
These definitions were written by [Nikolai Kolodziej](https://github.com/kldzj).

---
_Source: https://npm.io/package/@types/omgopass · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._