Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions .github/workflows/node.js.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
# This workflow will do a clean installation of node dependencies, cache/restore them, build the source code and run tests across different versions of node
# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions

name: Node.js CI

on:
Expand All @@ -15,7 +12,7 @@ jobs:

strategy:
matrix:
node-version: [18.x, 20.x, 22.x]
node-version: [22.x, 24.x, 25.x]

steps:
- uses: actions/checkout@v4
Expand Down
1 change: 0 additions & 1 deletion .npmignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
test/
coverage/
jest.config.js
.gitattributes
package-lock.json
.github/
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,12 @@

Join two iterables (e.g. arrays) of objects by a common (user-defined) key, similarly to how SQL JOIN, LEFT JOIN and FULL JOIN work.

[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)

## Installation

```sh
npm install array-join
```

or

```sh
yarn add array-join
```

## Usage

`join(leftCollection, rightCollection, getLeftKey, getRightKey, getResultItem)`
Expand Down Expand Up @@ -141,14 +133,19 @@ will include non-matching items from both collections
{
left: { id: 3, name: 'Alice' },
right: undefined
}
},
{
left: undefined,
right:{ personId: 4, address: { city: 'London', country: 'UK' } }
right: { personId: 4, address: { city: 'London', country: 'UK' } }
}
]
```

## Breaking changes in version 4

- ESM-only package (CommonJS is no longer supported)
- Minimum Node.js version is 22

## Breaking changes in version 3

- Rewritten on TypeScript (which ensures typings to be correct)
Expand Down
13 changes: 0 additions & 13 deletions jest.config.js

This file was deleted.

Loading
Loading