Class Encryption

constructor

• new Encryption(options: EncryptionOptions): Encryption

  Creates a new Encryption instance with the provided options

  Parameters

  • options: EncryptionOptions

    Configuration options for encryption

  Returns Encryption

verifier

base64

algorithm

• get algorithm(): "aes-256-cbc"

  The algorithm in use

  Returns "aes-256-cbc"

  The encryption algorithm being used

encrypt

• encrypt(payload: any, expiresIn?: string | number, purpose?: string): string

  Encrypt a given piece of value using the app secret. A wide range of data types are supported.

  • String
  • Arrays
  • Objects
  • Booleans
  • Numbers
  • Dates

  You can optionally define a purpose for which the value was encrypted and mentioning a different purpose/no purpose during decrypt will fail.

  Parameters

  • payload: any

    The data to be encrypted

  • OptionalexpiresIn: string | number

    Optional expiration time

  • Optionalpurpose: string

    Optional purpose for which the value is encrypted

  Returns string

  The encrypted payload as a string

decrypt

• decrypt<T extends unknown>(value: unknown, purpose?: string): null | T

  Decrypt value and verify it against a purpose

  Type Parameters

  • T extends unknown

  Parameters

  • value: unknown

    The encrypted value to decrypt

  • Optionalpurpose: string

    Optional purpose that the value was encrypted for

  Returns null | T

  The decrypted data if valid, null if decryption fails

child

• child(options?: EncryptionOptions): Encryption

  Create a children instance with different secret key

  Parameters

  • Optionaloptions: EncryptionOptions

    Optional configuration options to override

  Returns Encryption

  A new Encryption instance with the merged options