multiformats - npm Package Compare versions

Comparing version 10.0.2 to 10.0.3

CHANGELOG.md

@@ -0,1 +1,8 @@
+## [10.0.3](https://github.com/multiformats/js-multiformats/compare/v10.0.2...v10.0.3) (2022-12-16)
+
+
+### Documentation
+
+* publish typedocs in gh-pages branch ([#233](https://github.com/multiformats/js-multiformats/issues/233)) ([3a6d3ed](https://github.com/multiformats/js-multiformats/commit/3a6d3ed1f653d62e30d72d7bd00dc5815a17ffe3))
+
 ## [10.0.2](https://github.com/multiformats/js-multiformats/compare/v10.0.1...v10.0.2) (2022-10-19)
@@ -2,0 +9,0 @@

dist/types/src/bases/interface.d.ts

@@ -36,3 +36,3 @@ /**
  */
-export declare type Multibase<Prefix extends string> = string | string & {
+export type Multibase<Prefix extends string> = string | string & {
     [0]: Prefix;
@@ -39,0 +39,0 @@ };

dist/types/src/block/interface.d.ts

@@ -43,3 +43,3 @@ import { Link, Version } from '../link/interface.js';
 }
-export declare type BlockCursorView<T extends unknown = unknown> = {
+export type BlockCursorView<T extends unknown = unknown> = {
     value: T;
@@ -46,0 +46,0 @@ remaining?: undefined;

dist/types/src/link/interface.d.ts

@@ -5,5 +5,5 @@ import type { MultihashDigest } from '../hashes/interface.js';
 export type { MultihashDigest, MultibaseEncoder, MultibaseDecoder };
-export declare type Version = 0 | 1;
-export declare type DAG_PB = 0x70;
-export declare type SHA_256 = 0x12;
+export type Version = 0 | 1;
+export type DAG_PB = 0x70;
+export type SHA_256 = 0x12;
 /**
@@ -36,5 +36,5 @@ * Represents an IPLD link to a specific data of type `T`.
 }
-export declare type UnknownLink = LegacyLink<unknown> | Link<unknown, number, number, Version>;
-export declare type ToString<T, Prefix extends string = string> = Multibase<Prefix> & Phantom<T>;
+export type UnknownLink = LegacyLink<unknown> | Link<unknown, number, number, Version>;
+export type ToString<T, Prefix extends string = string> = Multibase<Prefix> & Phantom<T>;
 export type { ByteView };
 //# sourceMappingURL=interface.d.ts.map

package.json

 {
   "name": "multiformats",
-  "version": "10.0.2",
+  "version": "10.0.3",
   "description": "Interface for multihash, multicodec, multibase and CID",
@@ -49,3 +49,3 @@ "author": "Mikeal Rogers <[e-mail]> (https://www.mikealrogers.com/)",
     "tsconfig.json",
-    "dist/types",
+    "dist",
     "vendor",
@@ -254,2 +254,3 @@ "!**/*.tsbuildinfo",
     "release": "aegir release",
+    "docs": "aegir docs",
     "test": "npm run lint && npm run test:node && npm run test:chrome && npm run test:ts",
@@ -268,3 +269,3 @@ "test:ts": "npm run test --prefix test/ts-use",
     "@types/node": "^18.0.0",
-    "aegir": "^37.5.1",
+    "aegir": "^37.7.5",
     "buffer": "^6.0.3",
@@ -271,0 +272,0 @@ "cids": "^1.1.9"

README.md

@@ -5,3 +5,3 @@ # multiformats <!-- omit in toc -->
 [![codecov](https://img.shields.io/codecov/c/github/multiformats/js-multiformats.svg?style=flat-square)](https://codecov.io/gh/multiformats/js-multiformats)
-[![CI](https://img.shields.io/github/workflow/status/multiformats/js-multiformats/test%20&%20maybe%20release/esm-migration?style=flat-square)](https://github.com/multiformats/js-multiformats/actions/workflows/js-test-and-release.yml)
+[![CI](https://img.shields.io/github/actions/workflow/status/multiformats/js-multiformats/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/multiformats/js-multiformats/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)
 
@@ -13,2 +13,3 @@ > Interface for multihash, multicodec, multibase and CID
 - [Install](#install)
+  - [Browser `<script>` tag](#browser-script-tag)
 - [Interfaces](#interfaces)
@@ -25,2 +26,3 @@ - [Creating Blocks](#creating-blocks)
   - [IPLD codecs (multicodec)](#ipld-codecs-multicodec)
+- [API Docs](#api-docs)
 - [License](#license)
@@ -35,2 +37,10 @@ - [Contribution](#contribution)
 
+### Browser `<script>` tag
+
+Loading this module through a script tag will make it's exports available as `Multiformats` in the global namespace.
+
+```html
+<script src="https://unpkg.com/multiformats/dist/index.min.js"></script>
+```
+
 ## Interfaces
@@ -240,2 +250,6 @@
 
+## API Docs
+
+- <https://multiformats.github.io/js-multiformats>
+
 ## License
@@ -242,0 +256,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

Lines of code

5224

increased by1.63%

Number of lines in readme file

260

increased by5.69%

Worsened metrics

Total package byte prevSize

246552

decreased by-10.99%

No dependency changes