fix: added docs

Author: arthurvinci

src/Types/NFTMap.ts

@@ -7,58 +7,92 @@ export class NFTMap<V> {
     this._map = new Map();
   }
 
-  // Helper function to convert an NFT to its string representation
+  /**
+   * Converts an NFT object into a string representation for use as a key in the map.
+   * @param nft - The NFT to convert to a key.
+   * @returns {string} - The string representation of the NFT (globalId).
+   */
   private toMapKey(nft: NFT): string {
     return nft.globalId();
   }
 
-  // Sets the value for a given NFT key
+  /**
+   * Sets the value for a given NFT key.
+   * @param nft - The NFT key.
+   * @param value - The value to associate with the NFT key.
+   */
   set(nft: NFT, value: V): void {
     this._map.set(this.toMapKey(nft), value);
   }
 
-  // Gets the value for a given NFT key
+  /**
+   * Gets the value associated with a given NFT key.
+   * @param nft - The NFT key.
+   * @returns - The value associated with the NFT key, or undefined if the key is not present.
+   */
   get(nft: NFT): V | undefined {
     return this._map.get(this.toMapKey(nft));
   }
 
-  // Checks if the map contains the given NFT key
+  /**
+   * Checks if the map contains the given NFT key.
+   * @param nft - The NFT key.
+   * @returns - True if the map contains the NFT key, otherwise false.
+   */
   has(nft: NFT): boolean {
     return this._map.has(this.toMapKey(nft));
   }
 
-  // Deletes a key-value pair by the given NFT key
+  /**
+   * Deletes the entry associated with a given NFT key.
+   * @param nft - The NFT key.
+   * @returns - True if the entry was successfully deleted, otherwise false.
+   */
   delete(nft: NFT): boolean {
     return this._map.delete(this.toMapKey(nft));
   }
 
-  // Clears the entire map
+  /**
+   * Clears all entries from the map.
+   */
   clear(): void {
     this._map.clear();
   }
 
-  // Returns the number of key-value pairs in the map
+  /**
+   * Returns the number of entries in the map.
+   * @returns {number} - The size of the map.
+   */
   size(): number {
     return this._map.size;
   }
 
-  // Iterates through the map and applies the callback function to each entry
+  /**
+   * Iterates through the map and applies a callback function to each entry.
+   * @param {Function} callback - A function that takes the value and NFT key as arguments.
+   */
   forEach(callback: (value: V, nft: NFT) => void): void {
     this._map.forEach((value, key) => {
       const nft = NFT.fromGlobalId(key);
       callback(value, nft);
     });
   }
 
-  // Converts the map back into an array of [NFT, V] pairs
+  /**
+   * Converts the map into an array of [NFT, V] pairs.
+   * @returns {[NFT, V][]} - An array of [NFT, V] pairs.
+   */
   toArray(): [NFT, V][] {
     return Array.from(this._map).map(([key, value]) => [
       NFT.fromGlobalId(key),
       value,
     ]);
   }
 
-  // Returns a string representation of the map (optional)
+  /**
+   * Returns a string representation of the map.
+   * @returns {string} - A string representation of the map's key-value pairs.
+   */
   toString(): string {
     return `{${Array.from(this._map)
       .map(([key, value]) => `${key}: ${value}`)

src/Types/NFTSet.ts

@@ -7,50 +7,79 @@ export class NFTSet {
     this._set = new Set();
   }
 
-  // Helper function to convert an NFT to its string representation
+  /**
+   * Converts an NFT object into a string representation for use as an item in the set.
+   * @param nft - The NFT to convert to a string.
+   * @returns {string} - The string representation of the NFT (globalId).
+   */
   private toSetItem(nft: NFT): string {
     return nft.globalId();
   }
 
-  // Adds an NFT to the set
+  /**
+   * Adds an NFT to the set.
+   * @param nft - The NFT to add.
+   */
   add(nft: NFT): void {
     this._set.add(this.toSetItem(nft));
   }
 
-  // Removes an NFT from the set
+  /**
+   * Removes an NFT from the set.
+   * @param nft - The NFT to remove.
+   * @returns - True if the NFT was successfully deleted, otherwise false.
+   */
   delete(nft: NFT): boolean {
     return this._set.delete(this.toSetItem(nft));
   }
 
-  // Checks if an NFT is in the set
+  /**
+   * Checks if an NFT is in the set.
+   * @param nft - The NFT to check.
+   * @returns - True if the set contains the NFT, otherwise false.
+   */
   has(nft: NFT): boolean {
     return this._set.has(this.toSetItem(nft));
   }
 
-  // Clears the entire set
+  /**
+   * Clears the entire set, removing all elements.
+   */
   clear(): void {
     this._set.clear();
   }
 
-  // Returns the size of the set
+  /**
+   * Returns the number of NFTs in the set.
+   * @returns {number} - The size of the set.
+   */
   size(): number {
     return this._set.size;
   }
 
-  // Iterates through the NFTs in the set
+  /**
+   * Iterates through the NFTs in the set and applies the provided callback function to each one.
+   * @param callback - A function that takes an NFT as its argument.
+   */
   forEach(callback: (nft: NFT) => void): void {
     this._set.forEach((item) => {
       const nft = NFT.fromGlobalId(item);
       callback(nft);
     });
   }
 
-  // Converts the set back into an array of NFTs
+  /**
+   * Converts the set into an array of NFT objects.
+   * @returns - An array of NFT objects.
+   */
   toArray(): NFT[] {
     return Array.from(this._set).map((item) => NFT.fromGlobalId(item));
   }
 
-  // Returns a string representation of the set
+  /**
+   * Returns a string representation of the set.
+   * @returns {string} - A string representing the NFTs in the set.
+   */
   toString(): string {
     return `[${Array.from(this._set).join(", ")}]`;
   }