binary-tree-typed 1.19.0

package/dist/binary-tree.d.ts

@@ -0,0 +1,30 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+import type { BinaryTreeNodeId, BinaryTreeNodeNested, BinaryTreeOptions } from 'data-structure-typed';
+import { AbstractBinaryTree, AbstractBinaryTreeNode } from 'data-structure-typed';
+import { IBinaryTree, IBinaryTreeNode } from 'data-structure-typed';
+export declare class BinaryTreeNode<T = any, NEIGHBOR extends BinaryTreeNode<T, NEIGHBOR> = BinaryTreeNodeNested<T>> extends AbstractBinaryTreeNode<T, NEIGHBOR> implements IBinaryTreeNode<T, NEIGHBOR> {
+}
+export declare class BinaryTree<N extends BinaryTreeNode<N['val'], N> = BinaryTreeNode> extends AbstractBinaryTree<N> implements IBinaryTree<N> {
+    /**
+     * This is a constructor function for a binary tree class that takes an optional options parameter.
+     * @param {BinaryTreeOptions} [options] - The `options` parameter is an optional object that can be passed to the
+     * constructor of the `BinaryTree` class. It allows you to customize the behavior of the binary tree by providing
+     * different configuration options.
+     */
+    constructor(options?: BinaryTreeOptions);
+    /**
+     * The function creates a new binary tree node with an optional value.
+     * @param {BinaryTreeNodeId} id - The `id` parameter is the identifier for the binary tree node. It is of type
+     * `BinaryTreeNodeId`, which represents the unique identifier for each node in the binary tree.
+     * @param [val] - The `val` parameter is an optional value that can be assigned to the node. It represents the value
+     * stored in the node.
+     * @returns a new instance of a BinaryTreeNode with the specified id and value.
+     */
+    createNode(id: BinaryTreeNodeId, val?: N['val']): N;
+}

package/dist/binary-tree.js

@@ -0,0 +1,59 @@
+"use strict";
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+var __extends = (this && this.__extends) || (function () {
+    var extendStatics = function (d, b) {
+        extendStatics = Object.setPrototypeOf ||
+            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
+            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
+        return extendStatics(d, b);
+    };
+    return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
+        extendStatics(d, b);
+        function __() { this.constructor = d; }
+        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BinaryTree = exports.BinaryTreeNode = void 0;
+var data_structure_typed_1 = require("data-structure-typed");
+var BinaryTreeNode = /** @class */ (function (_super) {
+    __extends(BinaryTreeNode, _super);
+    function BinaryTreeNode() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    return BinaryTreeNode;
+}(data_structure_typed_1.AbstractBinaryTreeNode));
+exports.BinaryTreeNode = BinaryTreeNode;
+var BinaryTree = /** @class */ (function (_super) {
+    __extends(BinaryTree, _super);
+    /**
+     * This is a constructor function for a binary tree class that takes an optional options parameter.
+     * @param {BinaryTreeOptions} [options] - The `options` parameter is an optional object that can be passed to the
+     * constructor of the `BinaryTree` class. It allows you to customize the behavior of the binary tree by providing
+     * different configuration options.
+     */
+    function BinaryTree(options) {
+        return _super.call(this, options) || this;
+    }
+    /**
+     * The function creates a new binary tree node with an optional value.
+     * @param {BinaryTreeNodeId} id - The `id` parameter is the identifier for the binary tree node. It is of type
+     * `BinaryTreeNodeId`, which represents the unique identifier for each node in the binary tree.
+     * @param [val] - The `val` parameter is an optional value that can be assigned to the node. It represents the value
+     * stored in the node.
+     * @returns a new instance of a BinaryTreeNode with the specified id and value.
+     */
+    BinaryTree.prototype.createNode = function (id, val) {
+        return new BinaryTreeNode(id, val);
+    };
+    return BinaryTree;
+}(data_structure_typed_1.AbstractBinaryTree));
+exports.BinaryTree = BinaryTree;

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './binary-tree';

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./binary-tree"), exports);

package/jest.config.js

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

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "binary-tree-typed",
+  "version": "1.19.0",
+  "description": "Binary Tree. Javascript & Typescript Data Structure.",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "rm -rf dist && npx tsc",
+    "test": "jest",
+    "build:docs": "typedoc --out docs ./src",
+    "deps:check": "dependency-cruiser src",
+    "build:publish": "npm run build && npm run build:docs && npm publish"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zrwusa/data-structure-typed"
+  },
+  "keywords": [
+    "Binary Tree",
+    "DFS",
+    "DFSIterative",
+    "BFS",
+    "Node",
+    "Parent",
+    "Child",
+    "Root",
+    "Leaf",
+    "Depth",
+    "Height",
+    "Traversal",
+    "Pre-order",
+    "In-order",
+    "Post-order",
+    "Level-order",
+    "Balanced",
+    "Unbalanced",
+    "Full Binary Tree",
+    "Complete Binary Tree",
+    "Perfect Binary Tree",
+    "Binary Search Tree",
+    "Binary Expression Tree",
+    "Binary Heap"
+  ],
+  "author": "Tyler Zeng zrwusa@gmail.com",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/zrwusa/data-structure-typed/issues"
+  },
+  "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",
+    "dependency-cruiser": "^13.1.2",
+    "jest": "^29.6.2",
+    "ts-jest": "^29.1.1",
+    "typedoc": "^0.24.8",
+    "typescript": "^4.9.5"
+  },
+  "dependencies": {
+    "data-structure-typed": "^1.19.3",
+    "zod": "^3.22.2"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,37 @@
+{
+  "compilerOptions": {
+    "declaration": true,
+    "outDir": "./dist",
+    "module": "commonjs",
+    "target": "es5",
+    "lib": [
+      "esnext",
+    ],
+    "strict": true,
+    "esModuleInterop": true,
+    "moduleResolution": "node",
+    "declarationDir": "./dist",
+    "skipLibCheck": true,
+    "downlevelIteration": true,
+    "experimentalDecorators": true,
+    //    "allowJs": true,
+    //    "allowSyntheticDefaultImports": true,
+    //    "forceConsistentCasingInFileNames": true,
+    //    "noFallthroughCasesInSwitch": true,
+    //    "resolveJsonModule": true,
+    //    "isolatedModules": true,
+    //    "noEmit": true,
+    "typeRoots": [
+      "node_modules/@types"
+    ]
+  },
+
+  "include": [
+    "src",
+  ],
+  "exclude": [
+//    "node_modules/data-structure-typed",
+    "node_modules",
+    "dist"
+  ]
+}