Lazy loading

The dictionaries are sizable, so it is recommended to use lazy loading.

Webpack

Webpack supports lazy-loading with some configuration; check out the documentationopen in new window.

Here's how you import it:

import { zxcvbn } from '@zxcvbn-ts/core'

This is how you lazy load dictionaries:

const loadOptions = async () => {
  const zxcvbnCommonPackage = await import(
    /* webpackChunkName: "zxcvbnCommonPackage" */ '@zxcvbn-ts/language-common'
  )
  const zxcvbnEnPackage = await import(
    /* webpackChunkName: "zxcvbnEnPackage" */ '@zxcvbn-ts/language-en'
  )

  return {
    dictionary: {
      ...zxcvbnCommonPackage.default.dictionary,
      ...zxcvbnEnPackage.default.dictionary,
    },
    graphs: zxcvbnCommonPackage.adjacencyGraphs,
    translations: zxcvbnEnPackage.default.translations,
  }
}

Somewhere in your application you can call the "loadOptions" function, then the dictionary load is executed.

//
// [your other code]
//
const run = async () => {
  const password = 'asdnlja978o'
  const options = await loadOptions()
  zxcvbnOptions.setOptions(options)
  const results = zxcvbn(password)
  console.log(results)
}

Fetch

If you don't use a bundler like webpack, you could fetch the dictionaries from GitHub or a hosted website:

const packages = [
  'https://yourWebsite/zxcvbn-ts-language-common/passwords.json',
  'https://yourWebsite/zxcvbn-ts-language-en/commonWords.json',
  'https://yourWebsite/zxcvbn-ts-language-en/firstnames.json',
  'https://yourWebsite/zxcvbn-ts-language-en/lastnames.json',
]

const loadDictionaries = async () => {
  const promises = packages.map(async (url) => {
    const response = await fetch(url)

    return response.json()
  })

  return Promise.all(promises)
}