Joy

Ruby-like extensions for TypeScript native objects. This library adds useful methods to Array, String, Number, Set, and Object prototypes to provide a more expressive, Ruby-inspired API.

Installation

npm install @dochne/joy

Usage

Simply import the library at the entry point of your application to enable all extensions:

import "@dochne/joy";

// Now you can use the extended methods
[1, 2, 3].first(); // 1
[1, 2, 3].last(); // 3
(5).times((i) => console.log(i)); // logs 0, 1, 2, 3, 4

"hello".insert(1, "a"); // "hallo"

API

Array Extensions

• first() - Returns the first element
• last() - Returns the last element
• eachCons(n) - Returns consecutive n-element subarrays
• eachWithObject(initial, block) - Iterates with an accumulator object
• filterMap(block) - Maps and filters in one pass
• groupBy(block) - Groups elements by a key function
• intersect(items) - Returns intersection with another collection
• max() - Returns maximum value (for number arrays)
• min() - Returns minimum value (for number arrays)
• product() - Returns product of all numbers, or cartesian product with arrays
• sortBy(block) - Sorts by a computed value
• sum(block?) - Returns sum of numbers
• tap(block) - Executes block and returns self
• then(block) - Pipes array into a function
• transpose() - Transposes a 2D array
• union(...arrays) - Returns union of arrays

Number Extensions

• times(block) - Executes block n times
• then(block) - Pipes number into a function

String Extensions

• insert(pos, char) - Inserts character at position
• remove(pos) - Removes character at position
• then(block) - Pipes string into a function

Set Extensions

• filter(block) - Filters set elements
• addMany(...items) - Adds multiple items at once

Object Extensions

• tap(block) - Executes block and returns self
• chain(block) - Pipes object into a function

Development

# Install dependencies
npm install

# Build the library
npm run build

# The compiled output will be in the dist/ directory

License

MIT