@peter.naydenov/shortcuts 2.0.0 → 2.1.0

package/Changelog.md

@@ -1,8 +1,13 @@
 ## Release History
 
 
+### 2.1.0 ( 2023-10-17 )
+- [x] Method `setDependencies` to add more external objects available in all action functions;
+- [x] Method `getDependencies` to look at existing `dependencies` list;
+
+
 
-### 2.0.0 ( 2023-10-14 )
+### 2.0.0 ( 2023-10-16 )
 - [x] HTML attribute `data-quick-click` is available to speed up single click response;
 - [x] Documentation on methods `pause` and `resume`;
 - [x] Method `listShortcuts` to get names of all shortcuts defined;

package/README.md

@@ -281,16 +281,18 @@ function myMouseHandler ({
 Description of the methods of shortcut instance:
 
 ```js
-  load          : 'Load and extend a shortcut definition.'
-, unload        : 'Remove a shortcut context with all its shortcuts.'
-, changeContext : 'Switch to existing shortcut context.'
-, emit          : 'Trigger a shortcut or custom event programmatically.'
-, pause         : 'Stop listening for shortcuts.'
-, resume        : 'Resume listening for shortcuts.'
-, listContexts  : 'Return list of available contexts.'
-, getContext    : 'Return a name of current context or null if there is no context selected'
-, getNote       : `Return a name of current note or null if note isn't set`
-, setNote       : 'Set a note to current context.'
+  load            : 'Load and extend a shortcut definition.'
+, unload          : 'Remove a shortcut context with all its shortcuts.'
+, changeContext   : 'Switch to existing shortcut context.'
+, emit            : 'Trigger a shortcut or custom event programmatically.'
+, pause           : 'Stop listening for shortcuts.'
+, resume          : 'Resume listening for shortcuts.'
+, listContexts    : 'Return list of available contexts.'
+, getContext      : 'Return a name of current context or null if there is no context selected'
+, getNote         : `Return a name of current note or null if note isn't set`
+, setNote         : 'Set a note to current context.'
+, setDependencies : 'Set dependencies that will be available in action functions.'
+, getDependencies : 'Return dependencies object.'
 ```
 
 ### How to 'pause' and 'resume'?

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peter.naydenov/shortcuts",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Context control of shortcuts based on keyboard and mouse events",
   "keywords": [
     "shortcut",

package/src/main.js

@@ -10,7 +10,7 @@
  *  - Development was started on June 21st, 2023
  *  - First version was published on August 14th, 2023
  *  - Method 'emit' was added on September 30st, 2023
- *  - Version 2.0.0 was published on October 14th, 2023
+ *  - Version 2.0.0 was published on October 16th, 2023
  */
 
 
@@ -112,6 +112,13 @@ function main ( options = {} ) {
      */
     API.setDependencies = (deps) => dependencies.extra = { ...dependencies.extra, ...deps }
 
+    /**
+     * @function getDependencies
+     * @description Get a dependency package that will be provided to each action function
+     * @returns {object} - Enumerate external dependencies
+     **/
+    API.getDependencies = () => dependencies.extra
+
 
 
     Object.entries ( methods ).forEach ( ([ name, method ]) => {