Package Exports

securejs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (securejs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

securejs

Go to documentation

Download

npm i securejs

Usage

JavaScript

const secure = require('securejs')

TypeScript

import * as secure from 'securejs'

Creating a new ID

secure.newId(10)

// Output: 2o9GCroXsD

secure.newId(10, 'string', {
    case: 'uppercase'
})

// Output: SUPRJVKXQL

secure.newId(10, 'number')

// Output: 6724359154

secure.makeId(10, index => index + 1)

// Output: 12345678910

Encryption / Decryption

// text, key
secure.encrypt('securejs is the best', 'abc123')

// Output: U2FsdGVkX1/IdEzGVRJ2NvQeVSImQrda0d4ucwpolRa4o7WPdspqxHWdz39Mz32G

// encrypted text, key
secure.decrypt('U2FsdGVkX1/IdEzGVRJ2NvQeVSImQrda0d4ucwpolRa4o7WPdspqxHWdz39Mz32G', 'abc123')

// Output: securejs is the best

Documentation

interface SecureOptions {
    // Letter capitalization
    // `uppercase`: Make all the letters upppercase
    // `lowercase`: Make all the letters lowercase
    // `any` (default): Randomize the capitalization
    case: 'uppercase' or 'lowercase' or 'any' (default)
}

// Creates a new ID with the specified character generation function
// length: The length of the new ID
// each: The character generation function. Takes in the index of the character, and returns a new character determined by the function
function makeId(length: number, each: (index: number) => any): string

// Creates a new ID with the specified length, type, and options
// length: The length of the new ID
// type: default is "any"
// type = "any": numbers and letters
// type = "number": just numbers
// type = "string": just letters
// options: To further customize the ID creation. Must explicitly specify the type if you want to add options
function newId(length: number, type?: 'any' or 'number' or 'string', options?: SecureOptions): string

// Encrypts text with a key
// text: What you want to encrypt
// key: The encryption key
function encrypt(text: string, key: string): string

// Decrypts encrypted text with a key
// text: The encrypted text you want to decrypt
// key: The encryption key (the key you encrypted the original text with)
function decrypt(text: string, key: string): string