@ethersproject/strings - npm Package Compare versions

Comparing version 5.0.2 to 5.0.3

lib.esm/_version.d.ts

@@ -1,1 +0,1 @@
-export declare const version = "strings/5.0.2";
+export declare const version = "strings/5.0.3";

lib.esm/_version.js

@@ -1,2 +0,2 @@
-export const version = "strings/5.0.2";
+export const version = "strings/5.0.3";
 //# sourceMappingURL=_version.js.map

lib/_version.d.ts

@@ -1,1 +0,1 @@
-export declare const version = "strings/5.0.2";
+export declare const version = "strings/5.0.3";

lib/_version.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.version = "strings/5.0.2";
+exports.version = "strings/5.0.3";
 //# sourceMappingURL=_version.js.map

package.json

 {
   "author": "Richard Moore <[e-mail]>",
   "dependencies": {
-    "@ethersproject/bytes": "^5.0.0",
-    "@ethersproject/constants": "^5.0.0",
-    "@ethersproject/logger": "^5.0.0"
+    "@ethersproject/bytes": "^5.0.4",
+    "@ethersproject/constants": "^5.0.3",
+    "@ethersproject/logger": "^5.0.5"
   },
@@ -30,5 +30,5 @@ "description": "String utility functions.",
   },
-  "tarballHash": "0x298793e57e515c78a05974109db27dfdf9edbb45e7fcdb4309d1d6006074f27b",
+  "tarballHash": "0x172ac2720dfbc80eba395f8f713decd246ed1cf6ecd524954a94ee92c398d7b9",
   "types": "./lib/index.d.ts",
-  "version": "5.0.2"
+  "version": "5.0.3"
 }

README.md

 String Manipulation Utilities
 =============================
 
-**EXPERIMENTAL**
+This sub-module is part of the [ethers project](https://github.com/ethers-io/ethers.js).
 
-Please see the [ethers](https://github.com/ethers-io/ethers.js) repository
-for more informations.
+It contains functions to safely convert between UTF-8 data, strings and Bytes32 strings
+(i.e. "short strings").
 
-API
----
+For more information, see the [documentation](https://docs.ethers.io/v5/api/utils/strings/).
 
-`@TODO`
+Importing
+---------
 
+Most users will prefer to use the [umbrella package](https://www.npmjs.com/package/ethers),
+but for those with more specific needs, individual components can be imported.
+
+```javascript
+const {
+
+    toUtf8Bytes,
+    toUtf8CodePoints,
+    toUtf8String,
+
+    formatBytes32String,
+    parseBytes32String,
+
+    nameprep
+
+    // Enums
+
+    Utf8ErrorFuncs,
+    Utf8ErrorReason,
+
+    UnicodeNormalizationForm
+
+    // Types
+
+    Utf8ErrorFunc,
+
+} = require("@ethersproject/strings");
+```
+
+
 License
@@ -15,0 +45,0 @@ -------

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

89643

increased by0.75%

Number of lines in readme file

48

increased by166.67%

Dependency changes

• Updated@ethersproject/bytes@^5.0.4

• Updated@ethersproject/constants@^5.0.3

• Updated@ethersproject/logger@^5.0.5