@wordpress/deprecated - npm Package Compare versions

Comparing version 2.10.0 to 2.11.0

build-module/index.js

@@ -9,3 +9,3 @@ /**
  *
- * @type {Object}
+ * @type {Record<string,true|undefined>}
  */
@@ -17,9 +17,9 @@
  *
- * @param {string}  feature             Name of the deprecated feature.
- * @param {?Object} options             Personalisation options
- * @param {?string} options.version     Version in which the feature will be removed.
- * @param {?string} options.alternative Feature to use instead
- * @param {?string} options.plugin      Plugin name if it's a plugin feature
- * @param {?string} options.link        Link to documentation
- * @param {?string} options.hint        Additional message to help transition away from the deprecated feature.
+ * @param {string} feature               Name of the deprecated feature.
+ * @param {Object} [options]             Personalisation options
+ * @param {string} [options.version]     Version in which the feature will be removed.
+ * @param {string} [options.alternative] Feature to use instead
+ * @param {string} [options.plugin]      Plugin name if it's a plugin feature
+ * @param {string} [options.link]        Link to documentation
+ * @param {string} [options.hint]        Additional message to help transition away from the deprecated feature.
  *
@@ -26,0 +26,0 @@ * @example

build/index.js

@@ -19,3 +19,3 @@ "use strict";
  *
- * @type {Object}
+ * @type {Record<string,true|undefined>}
  */
@@ -26,9 +26,9 @@ var logged = Object.create(null);
  *
- * @param {string}  feature             Name of the deprecated feature.
- * @param {?Object} options             Personalisation options
- * @param {?string} options.version     Version in which the feature will be removed.
- * @param {?string} options.alternative Feature to use instead
- * @param {?string} options.plugin      Plugin name if it's a plugin feature
- * @param {?string} options.link        Link to documentation
- * @param {?string} options.hint        Additional message to help transition away from the deprecated feature.
+ * @param {string} feature               Name of the deprecated feature.
+ * @param {Object} [options]             Personalisation options
+ * @param {string} [options.version]     Version in which the feature will be removed.
+ * @param {string} [options.alternative] Feature to use instead
+ * @param {string} [options.plugin]      Plugin name if it's a plugin feature
+ * @param {string} [options.link]        Link to documentation
+ * @param {string} [options.hint]        Additional message to help transition away from the deprecated feature.
  *
@@ -35,0 +35,0 @@ * @example

CHANGELOG.md

@@ -5,2 +5,8 @@ <!-- Learn how to maintain this file at https://github.com/WordPress/gutenberg/tree/master/packages#maintaining-changelogs. -->
 
+## 2.11.0 (2020-12-17)
+
+### New Feature
+
+- Include TypeScript type declarations ([#26429](https://github.com/WordPress/gutenberg/pull/26429))
+
 ## 2.6.0 (2019-08-29)
@@ -7,0 +13,0 @@

package.json

 {
 	"name": "@wordpress/deprecated",
-	"version": "2.10.0",
+	"version": "2.11.0",
 	"description": "Deprecation utility for WordPress.",
@@ -24,6 +24,7 @@ "author": "The WordPress Contributors",
 	"react-native": "src/index",
+	"types": "build-types",
 	"sideEffects": false,
 	"dependencies": {
-		"@babel/runtime": "^7.11.2",
-		"@wordpress/hooks": "^2.10.0"
+		"@babel/runtime": "^7.12.5",
+		"@wordpress/hooks": "^2.11.0"
 	},
@@ -33,3 +34,3 @@ "publishConfig": {
 	},
-	"gitHead": "cbcd167ffb9b67f87a79df71d95aa48dc4db1a64"
+	"gitHead": "0f57de12b3c47128b216629b08e5c1657e1ee329"
 }

README.md

@@ -57,8 +57,8 @@ # Deprecated
 -   _feature_ `string`: Name of the deprecated feature.
--   _options_ `?Object`: Personalisation options
--   _options.version_ `?string`: Version in which the feature will be removed.
--   _options.alternative_ `?string`: Feature to use instead
--   _options.plugin_ `?string`: Plugin name if it's a plugin feature
--   _options.link_ `?string`: Link to documentation
--   _options.hint_ `?string`: Additional message to help transition away from the deprecated feature.
+-   _options_ `[Object]`: Personalisation options
+-   _options.version_ `[string]`: Version in which the feature will be removed.
+-   _options.alternative_ `[string]`: Feature to use instead
+-   _options.plugin_ `[string]`: Plugin name if it's a plugin feature
+-   _options.link_ `[string]`: Link to documentation
+-   _options.hint_ `[string]`: Additional message to help transition away from the deprecated feature.
 
@@ -72,3 +72,3 @@ <a name="logged" href="#logged">#</a> **logged**
 
--   `Object` 
+-   `Record<string,(|undefined)>` 
 
@@ -75,0 +75,0 @@

src/index.js

@@ -10,3 +10,3 @@ /**
  *
- * @type {Object}
+ * @type {Record<string,true|undefined>}
  */
@@ -18,9 +18,9 @@ export const logged = Object.create( null );
  *
- * @param {string}  feature             Name of the deprecated feature.
- * @param {?Object} options             Personalisation options
- * @param {?string} options.version     Version in which the feature will be removed.
- * @param {?string} options.alternative Feature to use instead
- * @param {?string} options.plugin      Plugin name if it's a plugin feature
- * @param {?string} options.link        Link to documentation
- * @param {?string} options.hint        Additional message to help transition away from the deprecated feature.
+ * @param {string} feature               Name of the deprecated feature.
+ * @param {Object} [options]             Personalisation options
+ * @param {string} [options.version]     Version in which the feature will be removed.
+ * @param {string} [options.alternative] Feature to use instead
+ * @param {string} [options.plugin]      Plugin name if it's a plugin feature
+ * @param {string} [options.link]        Link to documentation
+ * @param {string} [options.hint]        Additional message to help transition away from the deprecated feature.
  *
@@ -27,0 +27,0 @@ * @example

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

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

67131

increased by53.07%

Number of package files

14

increased by40%

Lines of code

338

increased by16.55%

Number of medium supply chain risk alerts

0

decreased by-100%

Dependency changes

• Updated@babel/runtime@^7.12.5

• Updated@wordpress/hooks@^2.11.0