From: Justin Wind <justin.wind+git@gmail.com>
Date: Fri, 1 Mar 2024 01:55:46 +0000 (-0800)
Subject: minor doc update
X-Git-Tag: v2.0.2~2
X-Git-Url: http://git.squeep.com/?p=squeep-mystery-box;a=commitdiff_plain;h=bb961eddde4819cb9ac0a75151a99ea8e6e5ba53

minor doc update
---

diff --git a/lib/mystery-box.js b/lib/mystery-box.js
index a2ea8a8..55d1c38 100644
--- 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
-   * @returns {String}
+   * @returns {Promise<String>}
    */
   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
-   * @returns {Object}
+   * @returns {Promise<Object>}
    */
   async unpack(box) {
     const { stats, timingsMs } = MysteryBox._newStats('unpack');
@@ -522,7 +522,7 @@ class MysteryBox extends EventEmitter {
   /**
    * Everyone loves numbers.
    * @param {Object} timingsMs
-   * @returns 
+   * @returns {Object}
    */
   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;