PKG -- [util-address] Add JSDoc to util address (#1494)

* PKG -- [util-address] Add JSDoc to util address * PKG -- [util-address] Create changeset Co-authored-by: Chase Fleming <1666730+chasefleming@users.noreply.github.com>
onflow · Nov 18, 2022 · 5bec557 · 5bec557
1 parent d09b4b8
commit 5bec557
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/.changeset/seven-rules-travel.md b/.changeset/seven-rules-travel.md
@@ -0,0 +1,5 @@
+---
+"@onflow/util-address": minor
+---
+
+Add JSDoc to util-address package.
diff --git a/packages/util-address/src/index.js b/packages/util-address/src/index.js
@@ -1,13 +1,28 @@
-export function sansPrefix(address) {
+/**
+ * Removes 0x from address if present
+ * @param {string} address
+ * @returns {string}
+ */
+ export function sansPrefix(address) {
   if (address == null) return null
   return address.replace(/^0x/, "").replace(/^Fx/, "")
 }
 
+/**
+ * Adds 0x to address if not already present
+ * @param {string} address
+ * @returns {string}
+ */
 export function withPrefix(address) {
   if (address == null) return null
   return "0x" + sansPrefix(address)
 }
 
+/**
+ * Adds 0x to address if not already present
+ * @param {string} address
+ * @returns {string}
+ */
 export function display(address) {
   return withPrefix(address)
 }