1.0.1 ⢠Published 7 months ago
deca-random-data v1.0.1
š² Deca Random Bytes
A comprehensive, cryptographically secure random byte and number generator with multiple encoding support. šš
⨠Features
- š§© Generate random bytes in multiple encodings
- š³ Generate random integers in a specified range
- š Cross-environment support (Browser and Node.js)
- š TypeScript types included
- š”ļø Cryptographically secure random generation
š¦ Installation
npm install deca-random-bytes
š Project Structure
deca-random-bytes/
ā
āāā src/
ā āāā index.ts # Main source file
ā
āāā dist/ # Compiled JavaScript files
ā āāā index.js
ā āāā index.d.ts # TypeScript declaration file
ā
āāā tests/
ā āāā index.test.ts # Unit tests
ā
āāā package.json # Project configuration
āāā tsconfig.json # TypeScript configuration
āāā README.md # Project documentation
š Usage
Random Byte Generation
import { decaRandomBytes } from 'deca-random-bytes';
// Generate 16 random bytes in hex (default)
const hexToken = decaRandomBytes(16);
// Generate in different encodings
const base64Token = decaRandomBytes(16, 'base64');
const utf8Token = decaRandomBytes(16, 'utf8');
Multiple Random Byte Generation
import { decaMultiRandomBytes } from 'deca-random-bytes';
const tokens = decaMultiRandomBytes({
apiToken: { bytes: 16, encoding: 'hex' },
userId: { bytes: 8, encoding: 'base64url' },
sessionKey: { bytes: 32, encoding: 'base64' }
});
console.log(tokens.apiToken); // Hex-encoded random bytes
console.log(tokens.userId); // Base64URL-encoded random bytes
console.log(tokens.sessionKey); // Base64-encoded random bytes
Random Integer Generation
import { decaRandomInt } from 'deca-random-bytes';
// Generate a random integer between 1 and 100 (inclusive)
const randomNumber = decaRandomInt(1, 100);
console.log(randomNumber);
š Supported Encodings
hex
: Hexadecimal encoding š¢base64
: Base64 encoding šutf8
: UTF-8 text encoding šascii
: ASCII encoding š»base64url
: URL-safe Base64 encoding š
š Environment Support
Works in both browser and Node.js environments with cryptographically secure random number generation. š„ļø š±
š License
MIT License šļø
š¤ Contributing
Contributions, issues, and feature requests are welcome! Feel free to check issues page.
šØāš» Author
Tom Tarpey
- GitHub: @decagondev
1.0.1
7 months ago