@ckeditor/typedoc-plugins - npm Package Compare versions

Comparing version 44.0.0-alpha.5 to 44.0.0

lib/purge-private-api-docs/index.js

@@ -89,4 +89,4 @@ /**
 /**
- * @param {Object} reflection
- * @returns {Boolean}
+ * @param {object} reflection
+ * @returns {boolean}
  */
@@ -98,4 +98,4 @@ function isNonPublicReflection( reflection ) {
 /**
- * @param {Object} reflection
- * @returns {Boolean}
+ * @param {object} reflection
+ * @returns {boolean}
  */
@@ -119,4 +119,4 @@ function hasInternalTag( reflection ) {
 /**
- * @param {Object} reflection
- * @returns {Boolean}
+ * @param {object} reflection
+ * @returns {boolean}
  */
@@ -128,5 +128,5 @@ function isInheritedReflectionFromPrivatePackage( reflection ) {
 /**
- * @param {Object} reflection
+ * @param {object} reflection
  * @param {Array} reflection.sources
- * @param {Function} reflection.traverse
+ * @param {function} reflection.traverse
  * @param {Array} [reflection.children]
@@ -147,4 +147,4 @@ */
 /**
- * @param {String} fileName
- * @returns {Boolean}
+ * @param {string} fileName
+ * @returns {boolean}
  */
@@ -174,4 +174,4 @@ function isPrivatePackageFile( fileName ) {
 /**
- * @param {Object} node
- * @returns {Boolean}
+ * @param {object} node
+ * @returns {boolean}
  */
@@ -205,4 +205,4 @@ function isPublicApi( node ) {
 /**
- * @param {String} value
- * @returns {String}
+ * @param {string} value
+ * @returns {string}
  */
@@ -209,0 +209,0 @@ function normalizePath( value ) {

lib/symbol-fixer/index.js

@@ -42,4 +42,4 @@ /**
 /**
- * @param {String} value
- * @returns {Boolean}
+ * @param {string} value
+ * @returns {boolean}
  */
@@ -46,0 +46,0 @@ function isWrappedInSquareBrackets( value ) {

lib/tag-error/index.js

@@ -127,3 +127,3 @@ /**
  * Transforms a node or array of node to an array of objects that follow
- * @param {String|Object|null} commentChildrenOrValue
+ * @param {string|Object|null} commentChildrenOrValue
  * @returns {Array.<require('typedoc').CommentDisplayPart> }
@@ -130,0 +130,0 @@ */

lib/tag-event/index.js

@@ -108,3 +108,3 @@ /**
  * @param {require('typedoc').Reflection} reflection The found owner reflection for an event.
- * @returns {Boolean}
+ * @returns {boolean}
  */
@@ -128,3 +128,3 @@ function isClassOrInterface( reflection ) {
  * @param {require('typedoc').Reflection} reflection
- * @param {String} eventName
+ * @param {string} eventName
  */
@@ -270,4 +270,4 @@ function createNewEventReflection( ownerContext, reflection, eventName ) {
  *
- * @param {String} eventName
- * @returns {String}
+ * @param {string} eventName
+ * @returns {string}
  */
@@ -274,0 +274,0 @@ function normalizeEventName( eventName ) {

lib/tag-observable/index.js

@@ -108,8 +108,8 @@ /**
  * @param {require('typedoc').Context} context Current state of the converter.
- * @param {Object} options
- * @param {String} options.name Parameter name.
+ * @param {object} options
+ * @param {string} options.name Parameter name.
  * @param {require('typedoc').Reflection} options.parent Parent reflection where the parameter should belong.
  * @param {require('ts').SyntaxKind} options.kind Kind of the parameter.
- * @param {String} options.comment Parameter comment.
- * @param {Object} options.type
+ * @param {string} options.comment Parameter comment.
+ * @param {object} options.type
  * @returns {require('typedoc').Reflection}
@@ -116,0 +116,0 @@ */

lib/utils/index.js

@@ -25,3 +25,3 @@ /**
  * @param {require('typedoc').Reflection} reflection The reflection to check if it is valid.
- * @returns {Boolean}
+ * @returns {boolean}
  */
@@ -45,4 +45,4 @@ function isReflectionValid( reflection ) {
  * @param {require('typedoc').Reflection} reflection The reflection that contain given identifier.
- * @param {String} identifier An identifier to check.
- * @returns {Boolean}
+ * @param {string} identifier An identifier to check.
+ * @returns {boolean}
  */
@@ -62,4 +62,4 @@ function isIdentifierValid( reflection, identifier ) {
  *
- * @param {String} identifier An identifier to check.
- * @returns {Boolean}
+ * @param {string} identifier An identifier to check.
+ * @returns {boolean}
  */
@@ -74,4 +74,4 @@ function isAbsoluteIdentifier( identifier ) {
  * @param {require('typedoc').Reflection} reflection The reflection that contain given identifier.
- * @param {String} identifier An identifier to convert.
- * @returns {String}
+ * @param {string} identifier An identifier to convert.
+ * @returns {string}
  */
@@ -91,3 +91,3 @@ function toAbsoluteIdentifier( reflection, identifier ) {
  * @param {require('typedoc').Reflection} reflection A reflection for which we want to get its longname.
- * @returns {Array.<String>}
+ * @returns {Array.<string>}
  */
@@ -126,3 +126,3 @@ function getLongNameParts( reflection ) {
  * @param {require('typedoc').Reflection} reflection A reflection for which we want to get its TypeScript node.
- * @returns {Object|null}
+ * @returns {object|null}
  */
@@ -153,3 +153,3 @@ function getNode( reflection ) {
  * @param {require('typedoc').Reflection} reflection The reflection that contain given identifier.
- * @param {String} identifier The identifier to locate the target reflection.
+ * @param {string} identifier The identifier to locate the target reflection.
  * @returns {require('typedoc').Reflection|null}
@@ -156,0 +156,0 @@ */

package.json

 {
   "name": "@ckeditor/typedoc-plugins",
-  "version": "44.0.0-alpha.5",
+  "version": "44.0.0",
   "description": "Various TypeDoc plugins developed by the CKEditor 5 team.",
@@ -5,0 +5,0 @@ "keywords": [],

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

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

Number of low quality alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

53615

decreased by-0.01%

No dependency changes