Code Monkey home page Code Monkey logo

treewise's Introduction

treewise

treewise is a TypeScript utility library providing functions for deep copying objects and arrays, processing arrays in batches, and performing various operations on tree data structures. It is designed for high efficiency and ease of use in managing complex data structures.

Installation

Install treewise using npm:

npm install treewise

Usage

Import the functions you need from treewise:

import { deepCopy, processArrayInBatches, traverseTree, modifyTree } from 'treewise';

API Reference

deepCopy<T>(obj: T): T

Deeply copies an object or array.

  • Parameters:
    • obj: T - The object or array to be copied.
  • Returns: A deep copy of the object or array.

Example

const original = [{ a: 1 }, { b: 2 }];
const copied = deepCopy(original);

processArrayInBatches<T>(array: T[], batchSize: number): T[][]

Processes a large array by dividing it into batches of a specified size.

  • Parameters:
    • array: T[] - The array to be processed.
    • batchSize: number - The size of each batch.
  • Returns: An array of batches.

Example

const data = [1, 2, 3, 4, 5];
const batches = processArrayInBatches(data, 2);

traverseTree<T>(root: TTreeNode<T>, callback: (node: TTreeNode<T>, depth: number) => void, depth: number = 0)

Performs a depth-first traversal of a tree.

  • Parameters:
    • root: TTreeNode<T> - The root node of the tree.
    • callback: (node: TTreeNode<T>, depth: number) => void - The callback function to be invoked for each node.
    • depth: number (optional) - The current depth in the tree (default is 0).
  • Returns: void.

Example

const tree = { value: 1, children: [{ value: 2, children: [] }] };
traverseTree(tree, (node, depth) => console.log(node.value, depth));

modifyTree<T>(root: TTreeNode<T>, modifyFn: (node: TTreeNode<T>) => void)

Modifies the structure of a tree by applying a function to each node.

  • Parameters:
    • root: TTreeNode<T> - The root node of the tree.
    • modifyFn: (node: TTreeNode<T>) => void - The function to be applied to each node.
  • Returns: void.

Example

const tree = { value: 1, children: [{ value: 2, children: [] }] };
modifyTree(tree, node => { node.value *= 2; });

Interface TTreeNode<T>

Represents a node in a tree.

  • Properties:
    • value: T - The value of the node.
    • children: TTreeNode<T>[] - An array of child nodes.

License

This project is licensed under the MIT License.

treewise's People

Contributors

pouyapanahandeh avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.