Class HashManager<KnownHashers>

constructor

• new HashManager<KnownHashers extends Record<string, ManagerDriverFactory>>(
      config: { default?: keyof KnownHashers; list: KnownHashers },
  ): HashManager<KnownHashers>

  Type Parameters

  • KnownHashers extends Record<string, ManagerDriverFactory>

  Parameters

  • config: { default?: keyof KnownHashers; list: KnownHashers }

  Returns HashManager<KnownHashers>

config

use

• use<Hasher extends string | number | symbol>(hasher?: Hasher): Hash

  Use one of the registered hashers to hash values.

  manager.use() // returns default hasher
  manager.use('argon')
  Copy

  Type Parameters

  • Hasher extends string | number | symbol

  Parameters

  • Optionalhasher: Hasher

    The name of the hasher to use, defaults to the configured default

  Returns Hash

  Hash instance for the specified hasher

fake

• fake(): void

  Enable fake hash drivers to disable actual hashing for testing

  Returns void

restore

• restore(): void

  Restore normal hashing behavior by disabling fake mode

  Returns void

isValidHash

• isValidHash(value: string): boolean

  Check if the value is a valid hash. This method just checks for the formatting of the hash

  Parameters

  • value: string

    The value to check

  Returns boolean

  True if the value is a valid hash format

make

• make(value: string): Promise<string>

  Hash plain text value using the default hasher

  Parameters

  • value: string

    The plain text value to hash

  Returns Promise<string>

  Promise resolving to the hashed value

verify

• verify(hashedValue: string, plainValue: string): Promise<boolean>

  Verify the plain text value against an existing hash

  Parameters

  • hashedValue: string

    The hashed value to verify against

  • plainValue: string

    The plain text value to verify

  Returns Promise<boolean>

  Promise resolving to true if verification succeeds

needsReHash

• needsReHash(hashedValue: string): boolean

  Find if the hash value needs a rehash or not.

  Parameters

  • hashedValue: string

    The hashed value to check

  Returns boolean

  True if the hash needs to be rehashed

assertEquals

• assertEquals(hashedValue: string, plainValue: string): Promise<void>

  Assert the plain value passes the hash verification

  Parameters

  • hashedValue: string

    The hashed value to verify against

  • plainValue: string

    The plain text value to verify

  Returns Promise<void>

  Promise that resolves if verification passes, throws if it fails

assertNotEquals

• assertNotEquals(hashedValue: string, plainValue: string): Promise<void>

  Assert the plain value fails the hash verification

  Parameters

  • hashedValue: string

    The hashed value to verify against

  • plainValue: string

    The plain text value to verify

  Returns Promise<void>

  Promise that resolves if verification fails, throws if it passes