boil

Reduce a list of items down to one item

Usage

Given an array of items return the final item that wins the comparison condition. Useful for more complicated min/max.

import * as 
import _
_ from 'radashi'

const 
const gods: {
    name: string;
    power: number;
}[]
gods = [
  {
    
name: string
name: 'Ra',
    
power: number
power: 100,
  },
  {
    
name: string
name: 'Zeus',
    
power: number
power: 98,
  },
  {
    
name: string
name: 'Loki',
    
power: number
power: 72,
  },
]

const 
const boilByPower: {
    name: string;
    power: number;
} | null
boilByPower = 
import _
_.
boil<{
    name: string;
    power: number;
}>(array: readonly {
    name: string;
    power: number;
}[], compareFunc: (a: {
    name: string;
    power: number;
}, b: {
    name: string;
    power: number;
}) => {
    name: string;
    power: number;
}): {
    name: string;
    power: number;
} | null
export boil
Go through a list of items, starting with the first item, and
comparing with the second. Keep the one you want then compare that
to the next item in the list with the same.
@see ― https://radashi.js.org/reference/array/boil
@example 
boil([1, 2, 3, 0], (a, b) => a > b ? a : b) // 3
@version ― 12.1.0
boil(
const gods: {
    name: string;
    power: number;
}[]
gods, (
a: {
    name: string;
    power: number;
}
a, 
b: {
    name: string;
    power: number;
}
b) => (
a: {
    name: string;
    power: number;
}
a.
power: number
power > 
b: {
    name: string;
    power: number;
}
b.
power: number
power ? 
a: {
    name: string;
    power: number;
}
a : 
b: {
    name: string;
    power: number;
}
b))
// => { name: 'Ra', power: 100 }