# @types/maskedinput

> TypeScript definitions for maskedinput

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

## Install

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

## Health

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

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.34 |
| Published | 2023-11-07 |
| First published | 2016-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51449 |
| Maintainers | types |

## Links

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

## Dependencies (1)

- [@types/jquery](https://npm.io/package/@types/jquery.md) *

## Recent versions

- 0.0.34 (latest) — 2023-11-07
- 0.0.31 (ts3.6) — 2021-07-08
- 0.0.30 (ts2.3) — 2017-08-21
- 0.0.28 (ts2.0) — 2016-09-19
- 0.0.33 — 2023-10-18
- 0.0.32 — 2023-09-27
- 0.0.29 — 2017-06-15
- 0.0.27 — 2016-07-14
- 0.0.26-alpha — 2016-07-08
- 0.0.25-alpha — 2016-07-04
- 0.0.24-alpha — 2016-07-02
- 0.0.23-alpha — 2016-07-01
- 0.0.22-alpha — 2016-07-01
- 0.0.21-alpha — 2016-05-25
- 0.0.20-alpha — 2016-05-20
- … 2 more at https://npm.io/package/@types/maskedinput/versions

## README

# Installation
> `npm install --save @types/maskedinput`

# Summary
This package contains type definitions for maskedinput (http://digitalbush.com/projects/masked-input-plugin).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/maskedinput.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/maskedinput/index.d.ts)
````ts
/// <reference types="jquery" />

interface JQueryMaskedInputOptions {
    mask?: string | undefined;
    alias?: string | undefined;
    placeholder?: string | undefined;
    repeat?: number | undefined;
    greedy?: boolean | undefined;
    skipOptionalPartCharacter?: string | undefined;
    clearIncomplete?: boolean | undefined;
    clearMaskOnLostFocus?: boolean | undefined;
    autoUnmask?: boolean | undefined;
    showMaskOnFocus?: boolean | undefined;
    showMaskOnHover?: boolean | undefined;
    showToolTip?: boolean | undefined;
    isComplete?: ((buffer: any, options: any) => {}) | undefined;
    numeric?: boolean | undefined;
    radixPoint?: string | undefined;
    rightAlignNumerics?: boolean | undefined;
    oncomplete?: ((value?: any) => void) | undefined;
    onincomplete?: (() => void) | undefined;
    oncleared?: (() => void) | undefined;
    onUnMask?: ((maskedValue: any, unmaskedValue: any) => void) | undefined;
    onBeforeMask?: ((initialValue: any) => void) | undefined;
    onKeyValidation?: ((result: any) => void) | undefined;
    onBeforePaste?: ((pastedValue: any) => void) | undefined;
}

interface MaskedInputStatic {
    defaults: MaskedInputDefaults;
    isValid: (value: string, options: MaskedInputStaticDefaults) => boolean;
    format: (value: string, options: MaskedInputStaticDefaults) => boolean;
}

interface MaskedInputStaticDefaults {
    alias: string;
}

interface MaskedInputDefaults {
    aliases: any;
    definitions: any;
}

interface JQueryStatic {
    mask: MaskedInputStatic;
}

interface JQuery {
    mask(mask: string, options?: JQueryMaskedInputOptions): JQuery;
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: [@types/jquery](https://npmjs.com/package/@types/jquery)

# Credits
These definitions were written by [Lokesh Peta](https://github.com/lokeshpeta).

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