effector-queue - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "effector-queue",
-  "version": "1.0.0",
-  "description": "",
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
+  "version": "1.0.1",
+  "description": "Library for sequential effect execution",
+  "type": "module",
+  "keywords": [
+    "effector",
+    "mutex"
+  ],
+  "author": "mishamyrt",
+  "license": "MIT",
   "devDependencies": {
@@ -25,4 +29,3 @@ "@types/node": "^20.11.25",
   },
-  "main": "dist/effector-queue.cjs.js",
-  "module": "dist/effector-queue.es.js",
+  "main": "dist/effector-queue.main.js",
   "types": "dist/effector-queue.d.ts",
@@ -29,0 +32,0 @@ "files": [

README.md

@@ -6,4 +6,7 @@ <p align="center">
         <a href="https://github.com/mishamyrt/effector-queue/actions/workflows/quality-assurance.yaml">
-            <img src="https://github.com/mishamyrt/effector-queue/actions/workflows/quality-assurance.yaml/badge.svg" />
+          <img src="https://github.com/mishamyrt/effector-queue/actions/workflows/quality-assurance.yaml/badge.svg" />
         </a>
+        <a href="https://www.npmjs.com/package/effector-queue">
+          <img src="https://img.shields.io/npm/v/effector-queue" />
+        </a>
     </p>
@@ -17,3 +20,15 @@ </p>
 ```sh
-pnpm add 
+npm install --save effector-queue@latest
+```
+
+## Usage
+
+To create a queue, use the `createQueue` method. It returns a constructor that returns the effects. Effects created in this way will not execute at the same time.
+
+```ts
+const [createQueueEffect] = createQueue()
+
+const firstFx = createQueueEffect(firstRequest)
+const secondFx = createQueueEffect(secondRequest)
+const thirdFx = createQueueEffect(thirdRequest)
 ```

Fixed alerts

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

No contributors or author data

Maintenance

Package does not specify a list of contributors or an author in package.json.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5278

increased by20.86%

Number of low maintenance alerts

1

decreased by-50%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

32

increased by88.24%

Is type module

Yes

Worsened metrics

Lines of code

68

decreased by-4.23%

No dependency changes