badges - npm Package Compare versions

Comparing version 4.1.0 to 4.2.0-next.1588764760.30d4ee1b58daa95db38d9b0e8a4a3c3c912c0ca4

HISTORY.md

 # History
 
+## v4.2.0 2020 May 6
+
+-   Export `BadgesList`, `BadgesConfig` `BadgesOptions`, and `BadgesField` types
+
 ## v4.1.0 2020 May 4
@@ -4,0 +8,0 @@

package.json

 {
   "name": "badges",
-  "version": "4.1.0",
+  "version": "4.2.0-next.1588764760.30d4ee1b58daa95db38d9b0e8a4a3c3c912c0ca4",
   "description": "The definitive collection of badges for rendering",
@@ -5,0 +5,0 @@ "homepage": "https://github.com/bevry/badges",

README.md

@@ -185,3 +185,3 @@ <!-- TITLE/ -->
 <script type="module">
-    import * as pkg from '//cdn.pika.dev/badges/^4.1.0'
+    import * as pkg from '//cdn.pika.dev/badges/^4.2.0'
 </script>
@@ -194,3 +194,3 @@ ```
 <script type="module">
-    import * as pkg from '//unpkg.com/badges@^4.1.0'
+    import * as pkg from '//unpkg.com/badges@^4.2.0'
 </script>
@@ -203,3 +203,3 @@ ```
 <script type="module">
-    import * as pkg from '//dev.jspm.io/badges@4.1.0'
+    import * as pkg from '//dev.jspm.io/badges@4.2.0'
 </script>
@@ -206,0 +206,0 @@ ```

source/index.ts

@@ -43,2 +43,12 @@ // Import
 export type BadgeEntries = BadgeEntry[]
+export type BadgesList = BadgeEntries
+export type BadgesOptions = RenderOptions
+export interface BadgesConfig {
+	[key: string]: any
+}
+export interface BadgesField {
+	list: BadgeEntries
+	config?: BadgesConfig
+	options?: RenderOptions
+}
 
@@ -53,4 +63,4 @@ /**
 export function renderBadges(
-	list: BadgeEntries,
-	config: { [key: string]: any } = {},
+	list: BadgesList,
+	config: BadgesConfig = {},
 	options: RenderOptions = { filterCategory: false, filterScripts: true }
@@ -57,0 +67,0 @@ ): string {

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

117327

increased by0.33%

Lines of code

2444

increased by0.41%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

No dependency changes