[//]: #@corifeus-header
[](https://www.npmjs.com/package/p3x-binary-search-closest/)
[](https://paypal.me/patrikx3) [](https://www.patrikx3.com/en/front/contact) [](https://www.facebook.com/corifeus.software) [](https://travis-ci.com/patrikx3/binary-search-closest)
[](https://uptimerobot.patrikx3.com/)
# 🚅 Find the closest value using binary search v2020.4.138
**Bugs are evident™ - MATRIX️**
### NodeJs LTS Version Requirement
```txt
>=12.13.0
```
### Built on NodeJs
```txt
v12.16.3
```
The ```async``` and ```await``` keywords are required. Only the latest LTS variant is supported.
Install NodeJs:
https://nodejs.org/en/download/package-manager/
# Description
[//]: #@corifeus-header:end
Before, you want to find the closest value in an array of objects or an array by values, it is important, so that you sort your array by the searching, otherwise will not work. Example below shows how it works.
The search algorithm is based on https://www.geeksforgeeks.org/find-closest-number-array/.
If you have a big array, you can use a worker thread as in the code is on the bottom (4 ways to do it / same as in the event loop, but without blocking the event loop.)
# Installation
```bash
npm install p3x-binary-search-closest
```
# Usage
Is you have mocha, you can test like this, it has a few use cases (you can see, before I execute this micro-service, I sort the array):
**Note:** Given npmjs.com has a narrow page, it is better to see the code on https://corifeus.com/binary-search-closest or https://github.com/patrikx3/binary-search-closest
```js
const assert = require('assert');
const bsClosest = require('p3x-binary-search-closest')
describe('binary search closest', () => {
it('binary search closest by array value, when it is exact match', () => {
const arr = [6, 9, 8, 4, 1, 7, 3, 10, 5, 2]
arr.sort()
const foundValue = bsClosest.byValue(arr, 5)
assert.ok(foundValue === 5)
})
it('binary search closest by array value, when it is not existing, but find the closest value', () => {
const arr = [9, 8, 4, 1, 7, 3, 10, 5, 2]
arr.sort()
const foundValue = bsClosest.byValue(arr, 6)
assert.ok(foundValue === 7)
})
it('binary search closest by array with a property, when it is exact match', () => {
const arr = [
{
id: 4538765,
value: 9
},
{
id: 4535675,
value: 10
},
{
id: 4535,
value: 1
},
{
id: 45654645,
value: 3
},
{
id: 123123123,
value: 2
},
{
id: 4532345,
value: 4
},
{
id: 4545335,
value: 7
},
{
id: 124535,
value: 6
},
{
id: 4587635,
value: 8
},
]
arr.sort((a, b) => (a.value > b.value) ? 1 : -1)
const foundValue = bsClosest.byProperty(arr, 7, 'value')
assert.ok(foundValue.value === 7)
})
it('binary search closest by array with a property, but find the closest value', () => {
const arr = [
{
id: 4538765,
value: 9
},
{
id: 4535675,
value: 10
},
{
id: 4535,
value: 1
},
{
id: 45654645,
value: 3
},
{
id: 123123123,
value: 2
},
{
id: 4532345,
value: 4
},
{
id: 4545335,
value: 7
},
{
id: 124535,
value: 6
},
{
id: 4587635,
value: 8
},
]
arr.sort((a, b) => (a.value > b.value) ? 1 : -1)
const foundValue = bsClosest.byProperty(arr, 5, 'value')
assert.ok(foundValue.value === 6)
})
it('using thread worker, binary search closest by array value, when it is exact match', async() => {
const arr = [6, 9, 8, 4, 1, 7, 3, 10, 5, 2]
arr.sort()
const foundValue = await bsClosest.worker({
type: 'value',
target: 5,
array: arr,
})
assert.ok(foundValue === 5)
})
it('using thread worker, binary search closest by array value, but find the closest value', async() => {
const arr = [9, 8, 4, 1, 7, 3, 10, 5, 2]
arr.sort()
const foundValue = await bsClosest.worker({
type: 'value',
target: -1,
array: arr,
})
assert.ok(foundValue === 1)
})
it('using thread worker, binary search closest by array with a property, when it is exact match', async() => {
const arr = [
{
id: 4538765,
value: 9
},
{
id: 4535675,
value: 10
},
{
id: 4535,
value: 1
},
{
id: 45654645,
value: 3
},
{
id: 123123123,
value: 2
},
{
id: 4532345,
value: 4
},
{
id: 4545335,
value: 7
},
{
id: 124535,
value: 6
},
{
id: 4587635,
value: 8
},
]
arr.sort((a, b) => (a.value > b.value) ? 1 : -1)
const foundValue = await bsClosest.worker({
type: 'property',
target: 7,
array: arr,
property: 'value',
})
assert.ok(foundValue.value === 7)
})
it('using thread worker, binary search closest by array with a property, but find the closest value', async() => {
const arr = [
{
id: 4538765,
value: 9
},
{
id: 4535675,
value: 10
},
{
id: 4535,
value: 1
},
{
id: 45654645,
value: 3
},
{
id: 123123123,
value: 2
},
{
id: 4532345,
value: 4
},
{
id: 4545335,
value: 7
},
{
id: 124535,
value: 6
},
{
id: 4587635,
value: 8
},
]
arr.sort((a, b) => (a.value > b.value) ? 1 : -1)
const foundValue = await bsClosest.worker({
type: 'property',
target: 5,
array: arr,
property: 'value',
})
assert.ok(foundValue.value === 6)
})
})
```
[//]: #@corifeus-footer
---
🙏 This is an open-source project. Star this repository, if you like it, or even donate to maintain the servers and the development. Thank you so much!
Possible, this server, rarely, is down, please, hang on for 15-30 minutes and the server will be back up.
All my domains ([patrikx3.com](https://patrikx3.com) and [corifeus.com](https://corifeus.com)) could have minor errors, since I am developing in my free time. However, it is usually stable.
**Note about versioning:** Versions are cut in Major.Minor.Patch schema. Major is always the current year. Minor is either 4 (January - June) or 10 (July - December). Patch is incremental by every build. If there is a breaking change, it should be noted in the readme.
---
[**P3X-BINARY-SEARCH-CLOSEST**](https://corifeus.com/binary-search-closest) Build v2020.4.138
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QZVM4V6HVZJW6) [](https://www.patrikx3.com/en/front/contact) [](https://www.facebook.com/corifeus.software)
## P3X Sponsor
[IntelliJ - The most intelligent Java IDE](https://www.jetbrains.com/?from=patrikx3)
[](https://www.jetbrains.com/?from=patrikx3)
[//]: #@corifeus-footer:end