stack-typed 1.19.3

package/dist/index.d.ts

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

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("./stack"), exports);

package/dist/stack.d.ts

@@ -0,0 +1,63 @@
+/**
+ * @license MIT
+ * @copyright Tyler Zeng <zrwusa@gmail.com>
+ * @class
+ */
+export declare class Stack<T = number> {
+    protected _elements: T[];
+    /**
+     * The constructor initializes an array of elements, which can be provided as an optional parameter.
+     * @param {T[]} [elements] - The `elements` parameter is an optional parameter of type `T[]`, which represents an array
+     * of elements of type `T`. It is used to initialize the `_elements` property of the class. If the `elements` parameter
+     * is provided and is an array, it is assigned to the `_elements
+     */
+    constructor(elements?: T[]);
+    /**
+     * The function "fromArray" creates a new Stack object from an array of elements.
+     * @param {T[]} elements - The `elements` parameter is an array of elements of type `T`.
+     * @returns {Stack} The method is returning a new instance of the Stack class, initialized with the elements from the input
+     * array.
+     */
+    static fromArray<T>(elements: T[]): Stack<T>;
+    /**
+     * The function checks if an array is empty and returns a boolean value.
+     * @returns A boolean value indicating whether the `_elements` array is empty or not.
+     */
+    isEmpty(): boolean;
+    /**
+     * The size() function returns the number of elements in an array.
+     * @returns The size of the elements array.
+     */
+    size(): number;
+    /**
+     * The `peek` function returns the last element of an array, or null if the array is empty.
+     * @returns The `peek()` function returns the last element of the `_elements` array, or `null` if the array is empty.
+     */
+    peek(): T | null;
+    /**
+     * The push function adds an element to the stack and returns the updated stack.
+     * @param {T} element - The parameter "element" is of type T, which means it can be any data type.
+     * @returns The `push` method is returning the updated `Stack<T>` object.
+     */
+    push(element: T): Stack<T>;
+    /**
+     * The `pop` function removes and returns the last element from an array, or returns null if the array is empty.
+     * @returns The `pop()` method is returning the last element of the array `_elements` if the array is not empty. If the
+     * array is empty, it returns `null`.
+     */
+    pop(): T | null;
+    /**
+     * The toArray function returns a copy of the elements in an array.
+     * @returns An array of type T.
+     */
+    toArray(): T[];
+    /**
+     * The clear function clears the elements array.
+     */
+    clear(): void;
+    /**
+     * The `clone()` function returns a new `Stack` object with the same elements as the original stack.
+     * @returns The `clone()` method is returning a new `Stack` object with a copy of the `_elements` array.
+     */
+    clone(): Stack<T>;
+}

package/dist/stack.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Stack = void 0;
+/**
+ * @license MIT
+ * @copyright Tyler Zeng <zrwusa@gmail.com>
+ * @class
+ */
+var Stack = /** @class */ (function () {
+    /**
+     * The constructor initializes an array of elements, which can be provided as an optional parameter.
+     * @param {T[]} [elements] - The `elements` parameter is an optional parameter of type `T[]`, which represents an array
+     * of elements of type `T`. It is used to initialize the `_elements` property of the class. If the `elements` parameter
+     * is provided and is an array, it is assigned to the `_elements
+     */
+    function Stack(elements) {
+        this._elements = Array.isArray(elements) ? elements : [];
+    }
+    /**
+     * The function "fromArray" creates a new Stack object from an array of elements.
+     * @param {T[]} elements - The `elements` parameter is an array of elements of type `T`.
+     * @returns {Stack} The method is returning a new instance of the Stack class, initialized with the elements from the input
+     * array.
+     */
+    Stack.fromArray = function (elements) {
+        return new Stack(elements);
+    };
+    /**
+     * The function checks if an array is empty and returns a boolean value.
+     * @returns A boolean value indicating whether the `_elements` array is empty or not.
+     */
+    Stack.prototype.isEmpty = function () {
+        return this._elements.length === 0;
+    };
+    /**
+     * The size() function returns the number of elements in an array.
+     * @returns The size of the elements array.
+     */
+    Stack.prototype.size = function () {
+        return this._elements.length;
+    };
+    /**
+     * The `peek` function returns the last element of an array, or null if the array is empty.
+     * @returns The `peek()` function returns the last element of the `_elements` array, or `null` if the array is empty.
+     */
+    Stack.prototype.peek = function () {
+        if (this.isEmpty())
+            return null;
+        return this._elements[this._elements.length - 1];
+    };
+    /**
+     * The push function adds an element to the stack and returns the updated stack.
+     * @param {T} element - The parameter "element" is of type T, which means it can be any data type.
+     * @returns The `push` method is returning the updated `Stack<T>` object.
+     */
+    Stack.prototype.push = function (element) {
+        this._elements.push(element);
+        return this;
+    };
+    /**
+     * The `pop` function removes and returns the last element from an array, or returns null if the array is empty.
+     * @returns The `pop()` method is returning the last element of the array `_elements` if the array is not empty. If the
+     * array is empty, it returns `null`.
+     */
+    Stack.prototype.pop = function () {
+        if (this.isEmpty())
+            return null;
+        return this._elements.pop() || null;
+    };
+    /**
+     * The toArray function returns a copy of the elements in an array.
+     * @returns An array of type T.
+     */
+    Stack.prototype.toArray = function () {
+        return this._elements.slice();
+    };
+    /**
+     * The clear function clears the elements array.
+     */
+    Stack.prototype.clear = function () {
+        this._elements = [];
+    };
+    /**
+     * The `clone()` function returns a new `Stack` object with the same elements as the original stack.
+     * @returns The `clone()` method is returning a new `Stack` object with a copy of the `_elements` array.
+     */
+    Stack.prototype.clone = function () {
+        return new Stack(this._elements.slice());
+    };
+    return Stack;
+}());
+exports.Stack = Stack;

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,62 @@
+{
+  "name": "stack-typed",
+  "version": "1.19.3",
+  "description": "Stack. 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": [
+    "Data structure",
+    "Stack",
+    "Last In, First Out (LIFO)",
+    "Push",
+    "Pop",
+    "Peek",
+    "Insertion",
+    "Deletion",
+    "Top",
+    "Element",
+    "Dynamic resizing",
+    "Memory management",
+    "Stack operations",
+    "Stack implementation",
+    "Stack frame",
+    "Function calls",
+    "Expression evaluation",
+    "Balancing symbols",
+    "Undo functionality",
+    "History tracking",
+    "Memory allocation",
+    "Data management",
+    "Sequential access"
+  ],
+  "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"
+  ]
+}