queue-typed 1.3.1 → 1.31.0

package/.eslintrc.js

@@ -0,0 +1,65 @@
+module.exports = {
+  'extends': [
+    'plugin:@typescript-eslint/recommended',
+    'prettier'
+  ],
+  'rules': {
+    'react/display-name': 'off',
+    '@next/next/no-img-element': 'off',
+    'react/no-unescaped-entities': 'off',
+    'import/no-anonymous-default-export': 'off',
+    '@typescript-eslint/no-unused-vars': 'error',
+    '@typescript-eslint/ban-ts-comment': 'off',
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    // add new line above comment
+    'lines-around-comment': [
+      'error',
+      {
+        'beforeLineComment': false,
+        'beforeBlockComment': true,
+        'allowBlockStart': true,
+        'allowClassStart': true,
+        'allowObjectStart': true,
+        'allowArrayStart': true
+      }
+    ],
+    // add new line above return
+    'newline-before-return': 'off',
+    // add new line below import
+    'import/newline-after-import': [
+      'error',
+      {
+        'count': 1
+      }
+    ],
+    '@typescript-eslint/ban-types': [
+      'error',
+      {
+        'extendDefaults': true,
+        'types': {
+          '{}': false
+        }
+      }
+    ]
+  },
+  'plugins': [
+    'import'
+  ],
+  'settings': {
+    'import/parsers': {
+      '@typescript-eslint/parser': [
+        '.ts',
+        '.tsx'
+      ]
+    },
+    'import/resolver': {
+      'typescript': {
+        'alwaysTryTypes': true,
+        'project': [
+          './tsconfig.json'
+        ]
+      }
+    }
+  }
+}

package/.prettierignore

@@ -0,0 +1,6 @@
+src/types/data-structures/abstract-binary-tree.ts
+src/types/data-structures/binary-tree.ts
+src/types/data-structures/bst.ts
+src/types/data-structures/avl-tree.ts
+src/types/data-structures/tree-multiset.ts
+src/types/data-structures/rb-tree.ts

package/.prettierrc.js

@@ -0,0 +1,16 @@
+module.exports = {
+  arrowParens: 'avoid',
+  bracketSpacing: true,
+  htmlWhitespaceSensitivity: 'css',
+  insertPragma: false,
+  bracketSameLine: false,
+  jsxSingleQuote: true,
+  printWidth: 120,
+  proseWrap: 'preserve',
+  quoteProps: 'as-needed',
+  requirePragma: false,
+  singleQuote: true,
+  tabWidth: 2,
+  trailingComma: 'none',
+  useTabs: false
+}

package/README.md

@@ -1,38 +1,85 @@
 # What
+
 ## Brief
-This is a standalone Queue data structure from the data-structure-typed collection. If you wish to access more data structures or advanced features, you can transition to directly installing the complete [data-structure-typed](https://www.npmjs.com/package/data-structure-typed) package
 
+<table>
+<thead>
+<tr><th>Data Structure</th><th>Enqueue Time Complexity</th><th>Dequeue Time Complexity</th><th>Element Access Time Complexity</th><th>Enqueue & Dequeue for 100000 elements</th><th>Access for 100000 elements</th></tr>
+</thead>
+<tbody>
+<tr><td>Queue</td><td>O(1)</td><td>O(1)</td><td>O(1)</td><td>22.60ms</td><td>10.60ms</td></tr>
+<tr><td>JavaScript Native Array</td><td>O(1)</td><td>O(n)</td><td>O(1)</td><td>931.10ms</td><td>8.60ms</td></tr>
+<tr><td>Other Queue</td><td>O(1)</td><td>O(1)</td><td>O(n)</td><td>28.90ms</td><td>17175.90ms</td></tr>
+</tbody>
+</table>
+
+## more data structures
+This is a standalone Queue data structure from the data-structure-typed collection. If you wish to access more data
+structures or advanced features, you can transition to directly installing the
+complete [data-structure-typed](https://www.npmjs.com/package/data-structure-typed) package
 
 # How
 
 ## install
+
 ### npm
+
 ```bash
-npm i queue-typed
+npm i queue-typed --save
 ```
+
 ### yarn
+
 ```bash
 yarn add queue-typed
 ```
+
 ### methods
 Queue
+![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/methods-8bit/array-queue.png?raw=true)
+LinkedListQueue
 ![](https://github.com/zrwusa/assets/blob/master/images/data-structure-typed/methods-8bit/queue.png?raw=true)
+
 ### snippet
+
 #### TS
-```typescript
-    import {Queue} from 'data-structure-typed';
-    // /* or if you prefer */ import {Queue} from 'priority-queue-typed';
 
+```typescript
+import {Queue} from 'queue-typed';
+// /* or if you prefer */ import {Queue} from 'queue-typed';
+
+const queue = new Queue<number>();
+for (let i = 0; i < magnitude; i++) {
+    queue.enqueue(i);
+}
+for (let i = 0; i < magnitude; i++) {
+    queue.dequeue();
+}
+
+for (let i = 0; i < magnitude; i++) {
+    console.log(queue.getAt(i));        // 0, 1, 2, 3, ...
+}
 ```
+
 #### JS
-```javascript
-    const {Queue} = require('data-structure-typed');
-    // /* or if you prefer */ const {Queue} = require('priority-queue-typed');
 
-    
+```javascript
+const {Queue} = require('queue-typed');
+// /* or if you prefer */ const {Queue} = require('queue-typed');
+
+const queue = new Queue();
+for (let i = 0; i < magnitude; i++) {
+    queue.enqueue(i);
+}
+for (let i = 0; i < magnitude; i++) {
+    queue.dequeue();
+}
+
+for (let i = 0; i < magnitude; i++) {
+    console.log(queue.getAt(i));        // 0, 1, 2, 3, ...
+}
 ```
 
-
 ## API docs & Examples
 
 [API Docs](https://data-structure-typed-docs.vercel.app)
@@ -234,7 +281,6 @@ Queue
 </tbody>
 </table>
 
-
 # Why
 
 ## Complexities

package/dist/index.d.ts

@@ -5,4 +5,4 @@
  * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
  * @license MIT License
  */
-export { Queue, ArrayQueue } from 'data-structure-typed';
+export { Queue, LinkedListQueue } from 'data-structure-typed';

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ArrayQueue = exports.Queue = void 0;
+exports.LinkedListQueue = exports.Queue = void 0;
 /**
  * data-structure-typed
  *
@@ -10,4 +10,4 @@ exports.ArrayQueue = exports.Queue = void 0;
  */
 var data_structure_typed_1 = require("data-structure-typed");
 Object.defineProperty(exports, "Queue", { enumerable: true, get: function () { return data_structure_typed_1.Queue; } });
-Object.defineProperty(exports, "ArrayQueue", { enumerable: true, get: function () { return data_structure_typed_1.ArrayQueue; } });
+Object.defineProperty(exports, "LinkedListQueue", { enumerable: true, get: function () { return data_structure_typed_1.LinkedListQueue; } });

package/jest.config.js

@@ -1,5 +1,5 @@
 module.exports = {
     preset: 'ts-jest',
     testEnvironment: 'node',
-    testMatch: ['<rootDir>/tests/**/*.test.ts'],
+    testMatch: ['<rootDir>/test/**/*.test.ts'],
 };

package/package.json

@@ -1,10 +1,12 @@
 {
   "name": "queue-typed",
-  "version": "1.3.1",
+  "version": "1.31.0",
   "description": "Queue, ArrayQueue. Javascript & Typescript Data Structure.",
   "main": "dist/index.js",
   "scripts": {
     "build": "rm -rf dist && npx tsc",
+    "lint": "eslint --fix \"src/**/*.{js,ts}\"",
+    "format": "prettier --write \"src/**/*.{js,ts}\"",
     "test": "jest",
     "build:docs": "typedoc --out docs ./src",
     "deps:check": "dependency-cruiser src",
@@ -38,10 +40,21 @@
   "homepage": "https://github.com/zrwusa/data-structure-typed#readme",
   "types": "dist/index.d.ts",
   "devDependencies": {
+    "@types/jest": "^29.5.3",
     "@types/node": "^20.4.9",
+    "@typescript-eslint/eslint-plugin": "^5.6.0",
+    "@typescript-eslint/parser": "^5.11.0",
+    "eslint": "^7.32.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-import-resolver-alias": "^1.1.2",
+    "eslint-import-resolver-typescript": "^2.5.0",
+    "eslint-plugin-import": "^2.25.4",
+    "jest": "^29.6.2",
+    "prettier": "^3.0.3",
+    "ts-jest": "^29.1.1",
     "typescript": "^4.9.5"
   },
   "dependencies": {
-    "data-structure-typed": "^1.3.1"
+    "data-structure-typed": "^1.31.0"
   }
 }

package/test/index.test.ts

@@ -0,0 +1,5 @@
+describe('Operation Test', () => {
+    it('should perform various operations well', () => {
+        expect(true).toBeTruthy();
+    });
+});