@onflow/util-address - npm Package Compare versions

Comparing version 1.1.0-alpha.0 to 1.1.0-alpha.1

CHANGELOG.md

 # @onflow/util-address
 
+## 1.1.0-alpha.1
+
+### Minor Changes
+
+- [#1547](https://github.com/onflow/fcl-js/pull/1547) [`2d143bc7`](https://github.com/onflow/fcl-js/commit/2d143bc7b30f59e9f9289eee020cfaae74b4f4e1) Thanks [@chasefleming](https://github.com/chasefleming)! - Add types for util-address package
+
 ## 1.1.0-alpha.0
@@ -4,0 +10,0 @@

dist/util-address.js

@@ -6,5 +6,5 @@ 'use strict';
 /**
- * Removes 0x from address if present
- * @param {string} address
- * @returns {string}
+ * @description Removes 0x from address if present
+ * @param {string} address - Flow address
+ * @returns {string} - Flow address without 0x prefix
  */
@@ -16,5 +16,5 @@ function sansPrefix(address) {
 /**
- * Adds 0x to address if not already present
- * @param {string} address
- * @returns {string}
+ * @description Adds 0x to address if not already present
+ * @param {string} address - Flow address
+ * @returns {string} - Flow address with 0x prefix
  */
@@ -27,5 +27,5 @@
 /**
- * Adds 0x to address if not already present
- * @param {string} address
- * @returns {string}
+ * @description Adds 0x to address if not already present
+ * @param {string} address - Flow address
+ * @returns {string} - Flow address with 0x prefix
  */
@@ -32,0 +32,0 @@

dist/util-address.module.js

 /**
- * Removes 0x from address if present
- * @param {string} address
- * @returns {string}
+ * @description Removes 0x from address if present
+ * @param {string} address - Flow address
+ * @returns {string} - Flow address without 0x prefix
  */
@@ -11,5 +11,5 @@ function sansPrefix(address) {
 /**
- * Adds 0x to address if not already present
- * @param {string} address
- * @returns {string}
+ * @description Adds 0x to address if not already present
+ * @param {string} address - Flow address
+ * @returns {string} - Flow address with 0x prefix
  */
@@ -22,5 +22,5 @@
 /**
- * Adds 0x to address if not already present
- * @param {string} address
- * @returns {string}
+ * @description Adds 0x to address if not already present
+ * @param {string} address - Flow address
+ * @returns {string} - Flow address with 0x prefix
  */
@@ -27,0 +27,0 @@

dist/util-address.umd.js

@@ -8,5 +8,5 @@ (function (global, factory) {
   /**
-   * Removes 0x from address if present
-   * @param {string} address
-   * @returns {string}
+   * @description Removes 0x from address if present
+   * @param {string} address - Flow address
+   * @returns {string} - Flow address without 0x prefix
    */
@@ -18,5 +18,5 @@ function sansPrefix(address) {
   /**
-   * Adds 0x to address if not already present
-   * @param {string} address
-   * @returns {string}
+   * @description Adds 0x to address if not already present
+   * @param {string} address - Flow address
+   * @returns {string} - Flow address with 0x prefix
    */
@@ -29,5 +29,5 @@
   /**
-   * Adds 0x to address if not already present
-   * @param {string} address
-   * @returns {string}
+   * @description Adds 0x to address if not already present
+   * @param {string} address - Flow address
+   * @returns {string} - Flow address with 0x prefix
    */
@@ -34,0 +34,0 @@

package.json

 {
   "name": "@onflow/util-address",
-  "version": "1.1.0-alpha.0",
+  "version": "1.1.0-alpha.1",
   "description": "Flow JS SDK Util -- Address",
@@ -23,4 +23,7 @@ "license": "Apache-2.0",
     "@onflow/types": "^1.0.4",
+    "eslint": "^8.33.0",
+    "eslint-plugin-jsdoc": "^39.7.5",
     "jest": "26.4.2",
-    "jest-esm-transformer": "1.0.0"
+    "jest-esm-transformer": "1.0.0",
+    "typescript": "^4.9.5"
   },
@@ -31,8 +34,11 @@ "source": "src/index.js",
   "unpkg": "dist/util-address.umd.js",
+  "types": "types/index.d.ts",
   "scripts": {
     "prepublishOnly": "npm test && npm run build",
     "test": "jest",
-    "build": "fcl-bundle",
+    "build": "npm run lint && fcl-bundle",
+    "build:types": "tsc",
     "test:watch": "jest --watch",
-    "start": "fcl-bundle --watch"
+    "start": "fcl-bundle --watch",
+    "lint": "eslint ."
   },
@@ -39,0 +45,0 @@ "dependencies": {

src/index.js

 /**
- * Removes 0x from address if present
- * @param {string} address
- * @returns {string}
+ * @description Removes 0x from address if present
+ * @param {string} address - Flow address
+ * @returns {string} - Flow address without 0x prefix
  */
@@ -12,5 +12,5 @@ export function sansPrefix(address) {
 /**
- * Adds 0x to address if not already present
- * @param {string} address
- * @returns {string}
+ * @description Adds 0x to address if not already present
+ * @param {string} address - Flow address
+ * @returns {string} - Flow address with 0x prefix
  */
@@ -23,5 +23,5 @@ export function withPrefix(address) {
 /**
- * Adds 0x to address if not already present
- * @param {string} address
- * @returns {string}
+ * @description Adds 0x to address if not already present
+ * @param {string} address - Flow address
+ * @returns {string} - Flow address with 0x prefix
  */
@@ -28,0 +28,0 @@ export function display(address) {

No alert changes

Improved metrics

Total package byte prevSize

14325

increased by23.56%

Number of package files

13

increased by18.18%

Lines of code

172

increased by36.51%

Worsened metrics

Dev dependency count

7

increased by75%

No dependency changes