Skip to content

Latest commit

 

History

History
341 lines (292 loc) · 12.3 KB

File metadata and controls

341 lines (292 loc) · 12.3 KB

Highdash API Reference

Complete documentation for all 228 Highdash functions

Table of Contents


Introduction

Highdash provides a modern, TypeScript-first alternative to Lodash, focusing on performance, type safety, and bundle optimization. This API reference serves as a comprehensive guide to all available functions.

Performance Highlights:

  • Up to 7.8× faster than Lodash (values function)
  • 4.4× faster deep cloning (cloneDeep)
  • 4.2× faster object merging (merge)
  • 2.1× faster array flattening (flattenDeep)
  • 1.6× faster deep equality checks (isEqual)

Performance metrics based on Node.js 18+ benchmarks, averaged over 5 runs.

Each module below contains detailed documentation for its respective functions, including parameters, return types, examples, and usage notes.


Core Functions

Essential functions for common programming patterns.


Array Functions

Functions for working with arrays and array-like objects.


Collection Functions

Functions for working with collections (arrays and objects).


Language Functions

Type checking, comparison, and conversion utilities.


Object Functions

Object property manipulation and iteration utilities.


Function Utilities

Functional programming utilities and function manipulation.


String Functions

String manipulation and formatting utilities.


Math Functions

Mathematical operations and calculations.


Number Functions

Number-specific utilities.


Utility Functions

General utilities, flow control, and modern async utilities.