Function mergeArgs

Returns an updated version of defaults merged with the contents of inputs.

Useful for parsing objects passed to functions with extra, optional options. Preserves all input properties.

Overloaded for better typing dependent on recursion.

Since

0.1.0

Since

PKG_VERSION — Added mergeArrays param.

mergeArgs<D extends object>(
    defaults: D,
    inputs?: undefined,
    recursive?: boolean,
    mergeArrays?: boolean,
): D
Inputs can be undefined, and if so, the default is returned.
Type Parameters
- D extends object
  Default object type.
Parameters
- defaults: D
  Default values (if not specified in inputs).
- Optionalinputs: undefined
  Overriding values (changes to make).
- Optionalrecursive: boolean
  Optional. Whether to merge the object recursively. Default false.
- OptionalmergeArrays: boolean
Returns D
Resulting object with all the defaults and inputs keys with either default values or input values, as appropriate.
- Defined in functions/objects/mergeArgs.ts:30
mergeArgs<D extends object, I extends Partial<D>>(
    defaults: D,
    inputs: I,
    recursive?: false,
    mergeArrays?: boolean,
): D & I
Passing recursive as false means that the input type must be a Partial (not RecursivePartial).
Type Parameters
- D extends object
- I extends Partial<D>
Parameters
- defaults: D
- inputs: I
- Optionalrecursive: false
- OptionalmergeArrays: boolean
Returns D & I
- Defined in functions/objects/mergeArgs.ts:43
mergeArgs<D extends object, I extends Partial<D> | RecursivePartial<D>>(
    defaults: D,
    inputs: I,
    recursive: true,
    mergeArrays?: boolean,
): D & I
Passing recursive as true means that the input type may actually be a RecursivePartial.
Type Parameters
- D extends object
- I extends Partial<D> | RecursivePartial<D>
Parameters
- defaults: D
- inputs: I
- recursive: true
- OptionalmergeArrays: boolean
Returns D & I
- Defined in functions/objects/mergeArgs.ts:57
mergeArgs<D extends object, I extends Partial<D> | RecursivePartial<D>>(
    defaults: D,
    inputs?: I,
    recursive?: boolean,
    mergeArrays?: boolean,
): D | D & I
Universal overload.
Type Parameters
- D extends object
- I extends Partial<D> | RecursivePartial<D>
Parameters
- defaults: D
- Optionalinputs: I
- Optionalrecursive: boolean
- OptionalmergeArrays: boolean
Returns D | D & I
- Defined in functions/objects/mergeArgs.ts:70

Function mergeArgs

Since

Since

Type Parameters

Parameters

Returns D

Type Parameters

Parameters

Returns D & I

Type Parameters

Parameters

Returns D & I

Type Parameters

Parameters

Returns D | D & I

Settings