electronade-endecoder-util

It's a package that provides some utilities for electronade-endecoder.

It's an optional module for electronade-endecoder so electronade-endecoder should be installed before using electronade-endecoder-util.

npm NPM npms.io (quality) Libraries.io dependency status for latest release Maintenance

installation

npm install electronade-endecoder-util

interfaces

classDiagram

class SecretKey {
  +constructor(password: string, salt: string, exposedName?: string)
  +encode(plainText: string) Promise~string~
  +decode(encodedText: string) Promise~string~
  +encrypt(plainBuffer: Buffer) Promise~string~
  +decrypt(encodedText: string) Promise~Buffer~
}

SecretKey
+constructor(password: string, salt: string, exposedName?: string)
+encode(plainText: string) : Promise<string>
+decode(encodedText: string) : Promise<string>
+encrypt(plainBuffer: Buffer) : Promise<string>
+decrypt(encodedText: string) : Promise<Buffer>
import { SecretKey } from "electronade-endecoder-util";

const key = new SecretKey("password", "salt");
const plainText = "this is a test":

const encodedText = await key.encode(plainText);

assert.equal(
  await key.decode(encodedText),
  plainText
);