uint8arrays - npm Package Compare versions

Comparing version 2.1.4 to 2.1.5

CHANGELOG.md

@@ -0,1 +1,10 @@
+## [2.1.5](https://github.com/achingbrain/uint8arrays/compare/v2.1.4...v2.1.5) (2021-04-15)
+
+
+### Features
+
+* export supported string encodings ([#18](https://github.com/achingbrain/uint8arrays/issues/18)) ([4b971ec](https://github.com/achingbrain/uint8arrays/commit/4b971ecd987b75fc90745866eebe4466e4c61a35))
+
+
+
 ## [2.1.4](https://github.com/achingbrain/uint8arrays/compare/v2.1.3...v2.1.4) (2021-04-06)
@@ -2,0 +11,0 @@

dist/from-string.d.ts

@@ -10,10 +10,10 @@ export = fromString;
  * @param {string} string
- * @param {BaseName | 'utf8' | 'utf-8' | 'ascii'} [encoding=utf8] - utf8, base16, base64, base64urlpad, etc
+ * @param {SupportedEncodings} [encoding=utf8] - utf8, base16, base64, base64urlpad, etc
  * @returns {Uint8Array}
  */
-declare function fromString(string: string, encoding?: "identity" | "base2" | "base8" | "base10" | "base16" | "base16upper" | "base32hex" | "base32hexupper" | "base32hexpad" | "base32hexpadupper" | "base32" | "base32upper" | "base32pad" | "base32padupper" | "base32z" | "base36" | "base36upper" | "base58btc" | "base58flickr" | "base64" | "base64pad" | "base64url" | "base64urlpad" | "utf8" | "utf-8" | "ascii" | undefined): Uint8Array;
+declare function fromString(string: string, encoding?: SupportedEncodings): Uint8Array;
 declare namespace fromString {
-    export { BaseName };
+    export { SupportedEncodings };
 }
-type BaseName = "identity" | "base2" | "base8" | "base10" | "base16" | "base16upper" | "base32hex" | "base32hexupper" | "base32hexpad" | "base32hexpadupper" | "base32" | "base32upper" | "base32pad" | "base32padupper" | "base32z" | "base36" | "base36upper" | "base58btc" | "base58flickr" | "base64" | "base64pad" | "base64url" | "base64urlpad";
+type SupportedEncodings = import('multibase/src/types').BaseName | 'utf8' | 'utf-8' | 'ascii' | undefined;
 //# sourceMappingURL=from-string.d.ts.map

dist/to-string.d.ts

@@ -10,10 +10,10 @@ export = toString;
  * @param {Uint8Array} array - The array to turn into a string
- * @param {BaseName | 'utf8' | 'utf-8' | 'ascii'} [encoding=utf8] - The encoding to use
+ * @param {SupportedEncodings} [encoding=utf8] - The encoding to use
  * @returns {string}
  */
-declare function toString(array: Uint8Array, encoding?: "identity" | "base2" | "base8" | "base10" | "base16" | "base16upper" | "base32hex" | "base32hexupper" | "base32hexpad" | "base32hexpadupper" | "base32" | "base32upper" | "base32pad" | "base32padupper" | "base32z" | "base36" | "base36upper" | "base58btc" | "base58flickr" | "base64" | "base64pad" | "base64url" | "base64urlpad" | "utf8" | "utf-8" | "ascii" | undefined): string;
+declare function toString(array: Uint8Array, encoding?: SupportedEncodings): string;
 declare namespace toString {
-    export { BaseName };
+    export { SupportedEncodings };
 }
-type BaseName = "identity" | "base2" | "base8" | "base10" | "base16" | "base16upper" | "base32hex" | "base32hexupper" | "base32hexpad" | "base32hexpadupper" | "base32" | "base32upper" | "base32pad" | "base32padupper" | "base32z" | "base36" | "base36upper" | "base58btc" | "base58flickr" | "base64" | "base64pad" | "base64url" | "base64urlpad";
+type SupportedEncodings = import('multibase/src/types').BaseName | 'utf8' | 'utf-8' | 'ascii' | undefined;
 //# sourceMappingURL=to-string.d.ts.map

from-string.js

@@ -7,3 +7,3 @@ 'use strict'
 /**
- * @typedef {import('multibase/src/types').BaseName} BaseName
+ * @typedef {import('multibase/src/types').BaseName | 'utf8' | 'utf-8' | 'ascii' | undefined} SupportedEncodings
  */
@@ -35,3 +35,3 @@
  * @param {string} string
- * @param {BaseName | 'utf8' | 'utf-8' | 'ascii'} [encoding=utf8] - utf8, base16, base64, base64urlpad, etc
+ * @param {SupportedEncodings} [encoding=utf8] - utf8, base16, base64, base64urlpad, etc
  * @returns {Uint8Array}
@@ -38,0 +38,0 @@ */

package.json

 {
   "name": "uint8arrays",
-  "version": "2.1.4",
+  "version": "2.1.5",
   "description": "Utility functions to make dealing with Uint8Arrays easier",
@@ -50,3 +50,3 @@ "main": "index.js",
   "devDependencies": {
-    "aegir": "^31.0.0"
+    "aegir": "^33.1.0"
   },
@@ -53,0 +53,0 @@ "eslintConfig": {

to-string.js

@@ -7,3 +7,3 @@ 'use strict'
 /**
- * @typedef {import('multibase/src/types').BaseName} BaseName
+ * @typedef {import('multibase/src/types').BaseName | 'utf8' | 'utf-8' | 'ascii' | undefined} SupportedEncodings
  */
@@ -34,3 +34,3 @@
  * @param {Uint8Array} array - The array to turn into a string
- * @param {BaseName | 'utf8' | 'utf-8' | 'ascii'} [encoding=utf8] - The encoding to use
+ * @param {SupportedEncodings} [encoding=utf8] - The encoding to use
  * @returns {string}
@@ -37,0 +37,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

Worsened metrics

Total package byte prevSize

16836

decreased by-3.69%

Lines of code

253

decreased by-1.56%

No dependency changes