order-with-group

A lightweight, zero-dependency TypeScript utility library for managing hierarchical ordered items with grouping support.

Features

• Zero dependencies – Lightweight and efficient.
• Simple API – Easy-to-use functions for managing ordered items.
• Grouping support – Handle hierarchical structures effortlessly.
• TypeScript-ready – Full type safety with generics.

Installation

npm install order-with-group

or

yarn add order-with-group

Usage

Importing

import { getItem, getSiblings, getNextItem, isFirst, isLast } from 'order-with-group';
import { OWG_Item } from 'order-with-group/types';

Data Structure

The library operates on items structured as follows:

type OWG_Item<T> = {
  id: T;
  order: number;
  title?: string;
  parentId?: T | null;
};

API Reference

getItem<T>(items: OWG_Item<T>[], id: T): OWG_Item<T> | undefined

Finds and returns an item by its id.

getSiblings<T>(items: OWG_Item<T>[], currentId: T): OWG_Item<T>[]

Retrieves all sibling items of the given currentId, sorted by order.

getNextItem<T>(items: OWG_Item<T>[], currentId: T): OWG_Item<T> | undefined

Finds the next item in the hierarchy based on order.

isFirst<T>(items: OWG_Item<T>[], currentId: T): boolean

Checks if the given item is the first among its siblings.

isLast<T>(items: OWG_Item<T>[], currentId: T): boolean

Checks if the given item is the last among its siblings.

hasAncestor<T>(items: OWG_Item<T>[], descendantId: T, ancestorId: T): boolean

Checks if the given item is descendant of.

License

MIT