@logux/core - npm Package Compare versions

Comparing version 0.3.2 to 0.3.3

base-node.js

@@ -588,3 +588,3 @@ var NanoEvents = require('nanoevents')
  * @param {string} nodeId Unique ID of remote node instance.
- * @return {Promise} Promise with boolean value.
+ * @return {Promise<boolean>} Promise with boolean value.
  */
@@ -596,4 +596,4 @@
  * @param {Meta} meta New action metadata.
- * @return {Promise} Promise with `true` if action should be synchronized
- *                   with remote log.
+ * @return {Promise<boolean>} Promise with `true` if action should
+ *                            be synchronized with remote log.
  */
@@ -605,3 +605,4 @@
  * @param {Meta} meta New action metadata.
- * @return {Promise} Promise with array of changed action and changed metadata.
+ * @return {Promise<Entry>} Promise with array of changed action
+ *                          and changed metadata.
  */

CHANGELOG.md

 # Change Log
 This project adheres to [Semantic Versioning](http://semver.org/).
 
+## 0.3.3
+* Fix JSDoc.
+
 ## 0.3.2
@@ -5,0 +8,0 @@ * Fix read-only meta keys.

index.js

@@ -53,8 +53,2 @@ var ServerConnection = require('./server-connection')
 /**
- * @callback listener
- * @param {Action} action New action.
- * @param {Meta} meta The action’s metadata.
- */
-
-/**
  * Array with {@link Action} and its {@link Meta}.
@@ -68,4 +62,18 @@ *
 /**
+ * If entry was not found Log return `[null, null]`.
+ *
+ * @typedef {Array} Nope
+ * @property {null} 0
+ * @property {null} 1
+ */
+
+/**
+ * @callback listener
+ * @param {Action} action New action.
+ * @param {Meta} meta The action’s metadata.
+ */
+
+/**
  * @callback next
- * @return {Promise} Promise with next {@link Page}.
+ * @return {Promise<Page>} Promise with next {@link Page}.
  */
@@ -106,4 +114,5 @@
  *
- * @return {Promise} Promise with `meta` for new action or `false`
- *                   if action with same `meta.id` was already in store.
+ * @return {Promise<Meta|false>} Promise with `meta` for new action or `false`
+ *                               if action with same `meta.id` was already
+ *                               in store.
  *
@@ -119,3 +128,3 @@ * @name add
  *
- * @return {Promise} Promise with entry if action was in store.
+ * @return {Promise<Entry|false>} Promise with entry if action was in store.
  *
@@ -138,3 +147,3 @@ * @name remove
  *
- * @return {Promise} Promise with first {@link Page}.
+ * @return {Promise<Page>} Promise with first {@link Page}.
  *
@@ -151,3 +160,3 @@ * @name get
  *
- * @return {Promise} Promise with `true` if metadata was changed
+ * @return {Promise<boolean>} Promise with `true` if metadata was changed
  *                   or `false` on unknown ID.
@@ -164,3 +173,3 @@ *
  *
- * @return {Promise} Promise with array of action and metadata.
+ * @return {Promise<Entry|Nope>} Promise with array of action and metadata.
  *
@@ -206,3 +215,3 @@ * @name byId
  *
- * @return {Promise} Promise with biggest `added` number.
+ * @return {Promise<number>} Promise with biggest `added` number.
  *
@@ -216,3 +225,3 @@ * @name getLastAdded
  *
- * @return {Promise} Promise with {@link LastSynced}.
+ * @return {Promise<number>} Promise with {@link LastSynced}.
  *
@@ -219,0 +228,0 @@ * @name getLastSynced

log.js

@@ -92,4 +92,4 @@ var NanoEvents = require('nanoevents')
    *                                 from previous actions.
-   * @return {Promise} Promise with `meta` if action was added to log
-   *                   or `false` if action was already in log
+   * @return {Promise<Meta|fale>} Promise with `meta` if action was added
+   *                              to log or `false` if action was already in log
    *
@@ -244,4 +244,4 @@ * @example
    *
-   * @return {Promise} Promise with `true` if metadata was changed
-   *                   or `false` on unknown ID.
+   * @return {Promise<boolean>} Promise with `true` if metadata was changed
+   *                            or `false` on unknown ID.
    *
@@ -285,5 +285,5 @@ * @example
    * @param {string} [criteria.olderThan] Remove reasons only for actions
-   *                                     with bigger `id`.
+   *                                      with bigger `id`.
    * @param {string} [criteria.youngerThan] Remove reason only for actions
-   *                                       with lower `id`.
+   *                                        with lower `id`.
    * @param {string} [criteria.id] Remove reason only for action with `id`.
@@ -311,3 +311,3 @@ *
    *
-   * @return {Promise} Promise with boolean.
+   * @return {Promise<Entry|Nope>} Promise with entry.
    *
@@ -314,0 +314,0 @@ * @example

logux-error.js

@@ -6,3 +6,3 @@ /**
  * @param {any} options The error option.
- * @param {boolean} received Was error received from remote node.
+ * @param {boolean} [received=false] Was error received from remote node.
  *
@@ -9,0 +9,0 @@ * @example

package.json

 {
   "name": "@logux/core",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "Logux core components",
@@ -24,4 +24,4 @@ "keywords": [
   "sharec": {
-    "version": "0.4.3"
+    "version": "0.4.4"
   }
 }

ws-connection.js

@@ -8,3 +8,3 @@ var NanoEvents = require('nanoevents')
  * @param {function} [WS] WebSocket class if you want change implementation.
- * @param {object} opts Extra option for WebSocket constructor.
+ * @param {object} [opts] Extra option for WebSocket constructor.
  *
@@ -11,0 +11,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

Improved metrics

Total package byte prevSize

100961

increased by0.4%

Lines of code

3170

increased by0.28%

No dependency changes