class MysteryBox extends EventEmitter {
/**
- * @param {Object} options
- * @param {String|String[]} options.encryptionSecret - if an array, will always encrypt with first secret, will attempt to decrypt with all; useful for rolling secrets
- * @param {Number=} options.defaultFlags
+ * @param {object} options options
+ * @param {string|string[]} options.encryptionSecret if an array, will always encrypt with first secret, will attempt to decrypt with all; useful for rolling secrets
+ * @param {number=} options.defaultFlags default flags to use when packing boxes
+ * @param {any[]} args passed on to EventEmitter constructor
*/
constructor(options = {}, ...args) {
super(...args);
/**
* Return an array containing x if x is something and not an array
- * @param {*} x
+ * @param {*} x thing to ensure is an array
+ * @returns {any[]} thing array or thing in an array
*/
static _ensureArray(x) {
if (x === undefined) {
/**
* Parse the bits out of the flags.
+ * @param {number} flags flags
+ * @returns {object} decoded flags
*/
static _decodeFlags(flags) {
return {
/**
* Generate key data.
+ * @param {string} deriver key deriver enum
+ * @param {Buffer} secret secret
+ * @param {Buffer} salt salt
+ * @param {number} keyBytes bytes in key
+ * @returns {Promise<Buffer>} key
*/
static async _keyFromSecret(deriver, secret, salt, keyBytes) {
switch (deriver) {
/**
* Return bits and bit mask for given number of encoded bytes.
- * @param {Number} numBytes
- * @returns {Object}
+ * @param {number} numBytes number of bytes
+ * @returns {object} bits value and mask
*/
static _versionHeaderBits(numBytes) {
// Round up to 8 bits in result, just to be proper.
* Number of packed bytes is indicated by location of first leading 0 bit.
* Support for numbers larger than 127 is of dubious practicality, but here
* it is anyhow.
- * @param {Number} firstByte
- * @returns {Object}
+ * @param {number} firstByte first byte contains encoded byte length
+ * @returns {object} number of bytes and masked first byte
*/
static _versionHeaderDecode(firstByte) {
for (let numBytes = 1; numBytes <= 8; numBytes++) {
* many total bytes comprise the version, in big-endian encoding.
* Returns decoded version and number of bytes used to decode.
* Only supports up to 6-byte numbers, and of those, only up to 4398046511103.
- * @param {Buffer} buf - N.B. will be mogrified
- * @returns {Object}
+ * @param {Buffer} buf N.B. will be mogrified
+ * @returns {object} decoded version and version byte length
*/
static _versionDecode(buf) {
const headerByte = buf.readUInt8(0);
/**
* Encode a version identifier into a buffer of a variable number of bytes.
- * @param {Number} version
- * @returns {Object}
+ * @param {number} version version number to encode
+ * @returns {object} encoded version buffer and number of bytes
*/
static _versionEncode(version) {
let versionBytes = 0;
/**
* Stats tracked when packing/unpacking boxes.
- * @returns {Object}
+ * @param {string} method method name generating stats
+ * @returns {object} stats and timings
*/
static _newStats(method) {
return {
/**
* Put contents into a mysterious box.
- * @param {Object|Buffer} contents
- * @param {Number=} version
- * @param {Number=} flags
- * @returns {Promise<String>}
+ * @param {object|Buffer} contents object or buffer
+ * @param {number=} version version
+ * @param {number=} flags flags
+ * @returns {Promise<string>} encoded contents
*/
async pack(contents, version = this.bestVersion, flags = this.defaultFlags) {
const { stats, timingsMs } = MysteryBox._newStats('pack');
break;
}
stats.compressedBytes = Buffer.byteLength(compressedContents);
- // const compressionRatio = stats.compressedBytes / stats.serializedBytes;
timingsMs.postCompress = timingsMs.preCrypt = performance.now();
let payload;
/**
* Take contents out of a mysterious box.
- * @param {String} box - Base64URL encoded payload
- * @returns {Promise<Object>}
+ * @param {string} box - Base64URL encoded payload
+ * @returns {Promise<object|Buffer>} decoded contents
*/
async unpack(box) {
const { stats, timingsMs } = MysteryBox._newStats('unpack');
/**
* Pretty-print flag values
- * @param {Number} flags
- * @returns {String}
+ * @param {number} flags flags
+ * @returns {string} pretty flags
*/
_prettyFlags(flags) {
const flagNames = Object.entries(this.Flags).reduce((acc, cur) => {
/**
* Everyone loves numbers.
- * @param {Object} timingsMs
- * @returns {Object}
+ * @param {object} timingsMs raw timings
+ * @param {number} timingsMs.start start
+ * @param {number} timingsMs.preCompress checkpoint
+ * @param {number} timingsMs.postCompress checkpoint
+ * @param {number} timingsMs.preCrypt checkpoint
+ * @param {number} timingsMs.postCrypt checkpoint
+ * @param {number} timingsMs.end checkpoint
+ * @returns {object} computed timings
*/
static _timingsLog({ start, preCompress, postCompress, preCrypt, postCrypt, end }) {
return {
projects / squeep-mystery-box / blobdiff