@adonisjs/encryption

Encryption

AdonisJs provider to encrypt and decrypt values

This module is used by AdonisJs to encrypt/decrypt values using a secret key.

Table of contents

• Usage
• Using with AdonisJs
• API Docs

Usage

Install the package from npm registry as follows:

npm i @adonisjs/encryption

# yarn
yarn add @adonisjs/encryption

and then use it as follows:

import { Encryption } from '@adonisjs/encryption/build/standalone'
const encryption = new Encryption('verylongandrandom32characterskey', {})

const encryptedValue = encryption.encrypt('hello-world')
encryption.decrypt(encryptedValue) // 'hello-world'

Using with AdonisJs

The @adonisjs/core module includes this module by default. However, here's how you can set it up manually.

const providers = [
  '@adonisjs/encryption'
]

And then also register the typings file inside tsconfig.json file.

{
  "files": ["./node_modules/@adonisjs/encryption/build/adonis-typings/encryption.d.ts"]
}

And use it as follows:

import Encryption from '@ioc:Adonis/Core/Encryption'
Encryption.encrypt('password')

API Docs

Following are the autogenerated files via Typedoc

• API