zxcvbn-ts

https://github.com/zxcvbn-ts/zxcvbn
Admin
zxcvbn-ts is a TypeScript rewrite of the zxcvbn password strength estimator, offering features like...
Tokens:44,413
Snippets:362
Trust Score:4.8
License:MIT
Update:2 days ago
Show doc for...
Tokens:
Raw
### Setup ZxcvbnFactory with Kurdish dictionary

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/ku/README.md

This example shows how to configure ZxcvbnFactory with the Kurdish dictionary and common package, then check a password.

```javascript
import { ZxcvbnFactory } from '@zxcvbn-ts/core'
import * as zxcvbnCommonPackage from '@zxcvbn-ts/language-common'
import * as zxcvbnKuPackage from '@zxcvbn-ts/language-ku'

const password = 'somePassword'
const options = {
  translations: zxcvbnEnPackage.translations,
  graphs: zxcvbnCommonPackage.adjacencyGraphs,
  dictionary: {
    ...zxcvbnCommonPackage.dictionary,
    ...zxcvbnKuPackage.dictionary,
  },
}
const zxcvbn = new ZxcvbnFactory(options)
zxcvbn.check(password)
```

--------------------------------

### Install with yarn

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/nl-be/README.md

Install the @zxcvbn-ts/language-nl-be package using yarn.

```bash
yarn add @zxcvbn-ts/language-nl-be
```

--------------------------------

### Install with npm

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/nl-be/README.md

Install the @zxcvbn-ts/language-nl-be package using npm.

```bash
npm install @zxcvbn-ts/language-nl-be --save
```

--------------------------------

### Install with npm

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/libraries/pwned/README.md

Install the core and pwned matcher packages via npm.

```bash
npm install @zxcvbn-ts/core @zxcvbn-ts/matcher-pwned --save
```

--------------------------------

### Install with npm

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/it/README.md

Install the Italian language package using npm.

```bash
npm install @zxcvbn-ts/language-it --save
```

--------------------------------

### Install with yarn

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/docs/guide/getting-started/README.md

Installs the same packages using yarn.

```shell
yarn add @zxcvbn-ts/core @zxcvbn-ts/language-common @zxcvbn-ts/language-en
```

--------------------------------

### Example implementation with lazy loading and custom matcher

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/docs/guide/best-practices/README.md

This example shows a complete setup following all best practices. It lazily loads language packages, enables Levenshtein distance, adds a custom userInputs dictionary, and uses the pwned matcher. The options are loaded asynchronously and passed to ZxcvbnFactory along with the custom matcher, then checkAsync is called with dynamic user content.

```typescript
import { ZxcvbnFactory } from '@zxcvbn-ts/core'
import { matcherPwnedFactory } from '@zxcvbn-ts/matcher-pwned'

const loadOptions = async () => {
  // common has some dictionaries which are not bound the any real language like a password list
  const zxcvbnCommonPackage = await import(
    /* webpackChunkName: "zxcvbnCommonPackage" */ '@zxcvbn-ts/language-common'
    )
  // As english is the language of the world it should always be included
  const zxcvbnEnPackage = await import(
    /* webpackChunkName: "zxcvbnEnPackage" */ '@zxcvbn-ts/language-en'
    )
  // The primary language of your website should align with the language predominantly used by your user base.
  const zxcvbnDePackage = await import(
    /* webpackChunkName: "zxcvbnDePackage" */ '@zxcvbn-ts/language-de'
    )

  return {
    translations: zxcvbnePackage.translations,
    graphs: zxcvbnCommonPackage.adjacencyGraphs,
    dictionary: {
      ...zxcvbnCommonPackage.dictionary,
      ...zxcvbnEnPackage.dictionary,
      ...zxcvbnDePackage.dictionary
      // Enhance the dictionary search by adding custom-defined keywords to a personalized dictionary, enabling seamless and consistent searches for application-wide terms.
      userInputs: ['MrWook', 'zxcvbn-ts', 'vuepress', 'npm', 'github', 'typescript']
    },
    useLevenshtein: true,
  }
}

const customMatcher = {
  pwned: matcherPwnedFactory(fetch)
}
const options = await loadOptions()
const zxcvbn = new ZxcvbnFactory(options, customMatcher)

zxcvbn.checkAsync('thePasswordInUse', ['username', 'user email', 'other dynamic user content'])
```

--------------------------------

### Install with npm

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/fa/README.md

Install the Persian language package using npm.

```bash
npm install @zxcvbn-ts/language-fa --save
```

--------------------------------

### Install with npm

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/th/README.md

Install the Thai language package using npm.

```bash
npm install @zxcvbn-ts/language-th --save
```

--------------------------------

### Install with yarn

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/libraries/pwned/README.md

Install the core and pwned matcher packages via yarn.

```bash
yarn add @zxcvbn-ts/core @zxcvbn-ts/matcher-pwned
```

--------------------------------

### Install with npm

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/pl/README.md

Install the Polish language package using npm.

```bash
npm install @zxcvbn-ts/language-pl --save
```

--------------------------------

### Install with yarn

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/it/README.md

Install the Italian language package using yarn.

```bash
yarn add @zxcvbn-ts/language-it
```

--------------------------------

### Install with npm

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/fi/README.md

Install the Finnish language package using npm.

```bash
npm install @zxcvbn-ts/language-fi --save
```

--------------------------------

### Install with yarn

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/th/README.md

Install the Thai language package using yarn.

```bash
yarn add @zxcvbn-ts/language-th
```

--------------------------------

### Install with pnpm

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/docs/guide/getting-started/README.md

Installs the same packages using pnpm.

```shell
pnpm add @zxcvbn-ts/core @zxcvbn-ts/language-common @zxcvbn-ts/language-en
```

--------------------------------

### Install with yarn

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/fa/README.md

Install the Persian language package using yarn.

```bash
yarn add @zxcvbn-ts/language-fa
```

--------------------------------

### Install with npm

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/ar/README.md

Install the Arabic language package using npm.

```bash
npm install @zxcvbn-ts/language-ar --save
```

--------------------------------

### Install with npm

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/id/README.md

Install the Indonesian language package using npm.

```bash
npm install @zxcvbn-ts/language-id --save
```

--------------------------------

### Install with yarn

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/pl/README.md

Install the Polish language package using yarn.

```bash
yarn add @zxcvbn-ts/language-pl
```

--------------------------------

### Install with yarn

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/fi/README.md

Install the Finnish language package using yarn.

```bash
yarn add @zxcvbn-ts/language-fi
```

--------------------------------

### Install with npm

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/da-dk/README.md

Install the Danish language package using npm.

```bash
npm install @zxcvbn-ts/language-da-dk --save
```

--------------------------------

### Install with npm

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/ko/README.md

Install the Korean language package using npm.

```bash
npm install @zxcvbn-ts/language-ko --save
```

--------------------------------

### Install with npm

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/ru/README.md

Install the Russian language package using npm.

```bash
npm install @zxcvbn-ts/language-ru --save
```

--------------------------------

### Install with yarn

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/id/README.md

Install the Indonesian language package using yarn.

```bash
yarn add @zxcvbn-ts/language-id
```

--------------------------------

### Install with npm

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/de/README.md

Install the German language package using npm.

```bash
npm install @zxcvbn-ts/language-de --save
```

--------------------------------

### Install with yarn

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/ar/README.md

Install the Arabic language package using yarn.

```bash
yarn add @zxcvbn-ts/language-ar
```

--------------------------------

### Install with yarn

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/ko/README.md

Install the Korean language package using yarn.

```bash
yarn add @zxcvbn-ts/language-ko
```

--------------------------------

### Install zxcvbn (Old)

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/docs/guide/migration/README.md

Install the original zxcvbn package using npm.

```bash
npm install zxcvbn
```

--------------------------------

### Install with yarn

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/da-dk/README.md

Install the Danish language package using yarn.

```bash
yarn add @zxcvbn-ts/language-da-dk
```

--------------------------------

### Install with npm

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/common/README.md

Install the common language package using npm.

```bash
npm install @zxcvbn-ts/language-common --save
```

--------------------------------

### Install with yarn

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/de/README.md

Install the German language package using yarn.

```bash
yarn add @zxcvbn-ts/language-de
```

--------------------------------

### Install with yarn

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/common/README.md

Install the common language package using yarn.

```bash
yarn add @zxcvbn-ts/language-common
```

--------------------------------

### Install with npm

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/pt-br/README.md

Install the Brazilian Portuguese language package using npm.

```bash
npm install @zxcvbn-ts/language-pt-br --save
```

--------------------------------

### Install @zxcvbn-ts/language-ja with yarn

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/ja/README.md

Install the Japanese language package using yarn.

```bash
yarn add @zxcvbn-ts/language-ja
```

--------------------------------

### Install @zxcvbn-ts/language-cs with yarn

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/cs/README.md

Install the Czech language package using yarn.

```bash
yarn add @zxcvbn-ts/language-cs
```

--------------------------------

### Install @zxcvbn-ts/language-ja with npm

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/ja/README.md

Install the Japanese language package using npm.

```bash
npm install @zxcvbn-ts/language-ja --save
```

--------------------------------

### Set up options with keyboard layouts (0.3.x to 1.x)

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/docs/guide/migration/README.md

Example of setting up zxcvbn options with translations, dictionaries, and adjacency graphs to maintain recommended scoring after keyboard layouts became optional.

```js
import { zxcvbn, zxcvbnOptions } from '@zxcvbn-ts/core'
import * as zxcvbnCommonPackage from '@zxcvbn-ts/language-common'
import * as zxcvbnEnPackage from '@zxcvbn-ts/language-en'

const options = {
  translations: zxcvbnEnPackage.translations,
  dictionary: {
    ...zxcvbnCommonPackage.dictionary,
    ...zxcvbnEnPackage.dictionary,
  },
  // Recommended to get accurate scoring for keyboard patterns
  graphs: zxcvbnCommonPackage.adjacencyGraphs,
}

zxcvbnOptions.setOptions(options)
zxcvbn(password)
```

--------------------------------

### Setup zxcvbn-ts with Russian language

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/ru/README.md

Configure ZxcvbnFactory with Russian translations and dictionaries, merging common and Russian dictionaries. The example checks a password strength.

```javascript
import { ZxcvbnFactory } from '@zxcvbn-ts/core'
import * as zxcvbnCommonPackage from '@zxcvbn-ts/language-common'
import * as zxcvbnRuPackage from '@zxcvbn-ts/language-ru'

const password = 'somePassword'
const options = {
  translations: zxcvbnRuPackage.translations,
  graphs: zxcvbnCommonPackage.adjacencyGraphs,
  dictionary: {
    ...zxcvbnCommonPackage.dictionary,
    ...zxcvbnRuPackage.dictionary,
  },
}
const zxcvbn = new ZxcvbnFactory(options)
zxcvbn.check(password)
```

--------------------------------

### Usage example with ZxcvbnFactory

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/docs/guide/getting-started/README.md

Shows how to import the library, configure options with translations, graphs, and dictionaries, and check a password synchronously or asynchronously.

```javascript
import { ZxcvbnFactory } from '@zxcvbn-ts/core'
import * as zxcvbnCommonPackage from '@zxcvbn-ts/language-common'
import * as zxcvbnEnPackage from '@zxcvbn-ts/language-en'

const password = 'somePassword'
const options = {
  translations: zxcvbnEnPackage.translations,
  graphs: zxcvbnCommonPackage.adjacencyGraphs,
  dictionary: {
    ...zxcvbnCommonPackage.dictionary,
    ...zxcvbnEnPackage.dictionary,
  },
}

const zxcvbn = new ZxcvbnFactory(options)
zxcvbn.check(password)
// or for async matchers
await zxcvbn.checkAsync(password)
```

--------------------------------

### Example of repeat matcher output

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/docs/guide/matcher/README.md

Shows the result of the repeat matcher for the string 'suchARandomRandomPassword'. The token 'RandomRandom' starts at index 5 and ends at index 16.

```text
i = 5
j = 16
token = RandomRandom
```

--------------------------------

### Set up zxcvbn-ts with custom options

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/libraries/main/README.md

Import the core and language packages, configure the dictionary, graphs, and translations, then create a ZxcvbnFactory instance and check a password.

```javascript
import { ZxcvbnFactory } from '@zxcvbn-ts/core'
import * as zxcvbnCommonPackage from '@zxcvbn-ts/language-common'
import * as zxcvbnEnPackage from '@zxcvbn-ts/language-en'

const options = {
  dictionary: {
    ...zxcvbnCommonPackage.dictionary,
    ...zxcvbnEnPackage.dictionary,
  },
  graphs: zxcvbnCommonPackage.adjacencyGraphs,
  translations: zxcvbnEnPackage.translations,
}
const zxcvbn = new ZxcvbnFactory(options)

const password = 'somePassword'
zxcvbn.check(password)
```

--------------------------------

### Setup with ZxcvbnFactory

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/common/README.md

Import the common package and create a ZxcvbnFactory instance to check password strength.

```javascript
import { ZxcvbnFactory } from '@zxcvbn-ts/core'
import * as zxcvbnCommonPackage from '@zxcvbn-ts/language-common'

const password = 'somePassword'
const options = {
  ...zxcvbnCommonPackage,
}

const zxcvbn = new ZxcvbnFactory(options)
zxcvbn.check(password)
```

--------------------------------

### Setup with ZxcvbnFactory

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/ko/README.md

Configure ZxcvbnFactory with Korean translations, common adjacency graphs, and combined dictionaries, then check a password.

```javascript
import { ZxcvbnFactory } from '@zxcvbn-ts/core'
import * as zxcvbnCommonPackage from '@zxcvbn-ts/language-common'
import * as zxcvbnKoPackage from '@zxcvbn-ts/language-ko'

const password = 'somePassword'
const options = {
  translations: zxcvbnKoPackage.translations,
  graphs: zxcvbnCommonPackage.adjacencyGraphs,
  dictionary: {
    ...zxcvbnCommonPackage.dictionary,
    ...zxcvbnKoPackage.dictionary,
  },
}
const zxcvbn = new ZxcvbnFactory(options)
zxcvbn.check(password)
```

--------------------------------

### Setup zxcvbn-ts with English language package

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/en/README.md

JavaScript setup that imports the core, common, and English packages, then creates a ZxcvbnFactory with translations, adjacency graphs, and merged dictionaries. The resulting instance checks a password.

```javascript
import { ZxcvbnFactory } from '@zxcvbn-ts/core'
import * as zxcvbnCommonPackage from '@zxcvbn-ts/language-common'
import * as zxcvbnEnPackage from '@zxcvbn-ts/language-en'

const password = 'somePassword'
const options = {
  translations: zxcvbnEnPackage.translations,
  graphs: zxcvbnCommonPackage.adjacencyGraphs,
  dictionary: {
    ...zxcvbnCommonPackage.dictionary,
    ...zxcvbnEnPackage.dictionary,
  },
}
const zxcvbn = new ZxcvbnFactory(options)
zxcvbn.check(password)
```

--------------------------------

### Install with yarn

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/hr/README.md

Install the Croatian language package using yarn.

```bash
yarn add @zxcvbn-ts/language-hr
```

--------------------------------

### Install with npm

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/hr/README.md

Install the Croatian language package using npm.

```bash
npm install @zxcvbn-ts/language-hr --save
```

--------------------------------

### Installation

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/docs/guide/getting-started/README.md

Install the core library and language packages using npm, yarn, or pnpm.

```APIDOC
## Installation

### npm
```shell
npm install @zxcvbn-ts/core @zxcvbn-ts/language-common @zxcvbn-ts/language-en
```

### yarn
```shell
yarn add @zxcvbn-ts/core @zxcvbn-ts/language-common @zxcvbn-ts/language-en
```

### pnpm
```shell
pnpm add @zxcvbn-ts/core @zxcvbn-ts/language-common @zxcvbn-ts/language-en
```
```

--------------------------------

### Install with yarn

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/ru/README.md

Install the Russian language package using yarn.

```bash
yarn add @zxcvbn-ts/language-ru
```

--------------------------------

### Install zxcvbn-ts with npm

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/libraries/main/README.md

Install the core library and the common language package via npm.

```bash
npm install @zxcvbn-ts/core @zxcvbn-ts/language-common --save
```

--------------------------------

### Setup with ZxcvbnFactory

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/languages/id/README.md

Configure zxcvbn-ts with Indonesian translations and dictionary, combining with the common package.

```javascript
import { ZxcvbnFactory } from '@zxcvbn-ts/core'
import * as zxcvbnCommonPackage from '@zxcvbn-ts/language-common'
import * as zxcvbnIdPackage from '@zxcvbn-ts/language-id'

const password = 'somePassword'
const options = {
  translations: zxcvbnIdPackage.translations,
  graphs: zxcvbnCommonPackage.adjacidcyGraphs,
  dictionary: {
    ...zxcvbnCommonPackage.dictionary,
    ...zxcvbnIdPackage.dictionary,
  },
}
const zxcvbn = new ZxcvbnFactory(options)
zxcvbn.check(password)
```

--------------------------------

### Install zxcvbn-ts packages

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/docs/guide/framework-examples/README.md

Install the core library and language packs for common and English dictionaries.

```bash
npm install @zxcvbn-ts/core @zxcvbn-ts/language-common @zxcvbn-ts/language-en
```

--------------------------------

### Install zxcvbn-ts with yarn

Source: https://github.com/zxcvbn-ts/zxcvbn/blob/master/packages/libraries/main/README.md

Install the core library and the common language package via yarn.

```bash
yarn add @zxcvbn-ts/core @zxcvbn-ts/language-common
```
Tokens:
Raw