projects
/
squeep-mystery-box
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (from parent 1:
4a59439
)
minor doc update
author
Justin Wind
<justin.wind+git@gmail.com>
Fri, 1 Mar 2024 01:55:46 +0000
(17:55 -0800)
committer
Justin Wind
<justin.wind+git@gmail.com>
Fri, 1 Mar 2024 01:56:15 +0000
(17:56 -0800)
lib/mystery-box.js
patch
|
blob
|
history
diff --git
a/lib/mystery-box.js
b/lib/mystery-box.js
index a2ea8a82b05919ccac0c166f681cfe2a64b56fce..55d1c3827746ccbc35b2e2e64ce30e9df692888f 100644
(file)
--- a/
lib/mystery-box.js
+++ b/
lib/mystery-box.js
@@
-305,7
+305,7
@@
class MysteryBox extends EventEmitter {
* @param {Object|Buffer} contents
* @param {Number=} version
* @param {Number=} flags
* @param {Object|Buffer} contents
* @param {Number=} version
* @param {Number=} flags
- * @returns {
String
}
+ * @returns {
Promise<String>
}
*/
async pack(contents, version = this.bestVersion, flags = this.defaultFlags) {
const { stats, timingsMs } = MysteryBox._newStats('pack');
*/
async pack(contents, version = this.bestVersion, flags = this.defaultFlags) {
const { stats, timingsMs } = MysteryBox._newStats('pack');
@@
-399,7
+399,7
@@
class MysteryBox extends EventEmitter {
/**
* Take contents out of a mysterious box.
* @param {String} box - Base64URL encoded payload
/**
* Take contents out of a mysterious box.
* @param {String} box - Base64URL encoded payload
- * @returns {
Object
}
+ * @returns {
Promise<Object>
}
*/
async unpack(box) {
const { stats, timingsMs } = MysteryBox._newStats('unpack');
*/
async unpack(box) {
const { stats, timingsMs } = MysteryBox._newStats('unpack');
@@
-522,7
+522,7
@@
class MysteryBox extends EventEmitter {
/**
* Everyone loves numbers.
* @param {Object} timingsMs
/**
* Everyone loves numbers.
* @param {Object} timingsMs
- * @returns
+ * @returns
{Object}
*/
static _timingsLog({ start, preCompress, postCompress, preCrypt, postCrypt, end }) {
return {
*/
static _timingsLog({ start, preCompress, postCompress, preCrypt, postCrypt, end }) {
return {
@@
-534,4
+534,4
@@
class MysteryBox extends EventEmitter {
}
}
-module.exports = MysteryBox;
\ No newline at end of file
+module.exports = MysteryBox;