Docs
useEncryption

Encrypt and decrypt data with the useEncryption hook, providing methods to encrypt and decrypt strings using AES encryption.

Loading...

Installation

pnpm dlx shadcn@latest add https://usekit.kiron.dev/k/use-encryption

Usage

"use client"
 
import { useEncryption } from "@/hooks/use-encryption"
 
export function Component() {
  const { encrypt, decrypt } = useEncryption()
 
  const handleEncrypt = () => {
    const encrypted = encrypt("Sensitive data", "my-secret-key")
    if (encrypted) {
      console.log("Encrypted:", encrypted)
    }
  }
 
  const handleDecrypt = () => {
    const decrypted = decrypt<string>("U2FsdGVkX1...", "my-secret-key")
    if (decrypted) {
      console.log("Decrypted:", decrypted)
    }
  }
 
  return (
    <div>
      <button onClick={handleEncrypt}>Encrypt Data</button>
      <button onClick={handleDecrypt}>Decrypt Data</button>
    </div>
  )
}

API Reference

Parameters

encrypt()

NameTypeDescriptionDefault ValueOptional
dataunknownThe data to be encryptedNo
secretstringThe secret key used for encryptionNo

decrypt()

NameTypeDescriptionDefault ValueOptional
cipherTextstringThe encrypted string to decryptNo
secretstringThe secret key used for decryptionNo

Return Values

NameTypeDescription
encrypt(data: unknown, secret: string) => string | nullFunction to encrypt data using AES encryption.
decrypt(cipherText: string, secret: string) => string | nullFunction to decrypt data using AES encryption.