Skip to content

Commit

Permalink
docs: add inline code quotes
Browse files Browse the repository at this point in the history
  • Loading branch information
RebeccaStevens committed Sep 13, 2021
1 parent f6c9361 commit 4943b87
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,33 +115,33 @@ Generate a customized deepmerge function using the given options. The returned f
  The following options can be used to customize the deepmerge function.\
  All these options are optional.

#####     mergeRecords
#####     `mergeRecords`

&nbsp;&nbsp;&nbsp; Type: `false | (values: Record<any, unknown>[], utils: DeepMergeMergeFunctionUtils) => unknown`

&nbsp;&nbsp;&nbsp; If false, records won't be merged. If set to a function, that function will be used to merge records.

&nbsp;&nbsp;&nbsp; Note: Records are "vanilla" objects (e.g. `{ foo: "hello", bar: "world" }`).

##### &nbsp;&nbsp;&nbsp; mergeArrays
##### &nbsp;&nbsp;&nbsp; `mergeArrays`

&nbsp;&nbsp;&nbsp; Type: `false | (values: unknown[][], utils: DeepMergeMergeFunctionUtils) => unknown`

&nbsp;&nbsp;&nbsp; If false, arrays won't be merged. If set to a function, that function will be used to merge arrays.

##### &nbsp;&nbsp;&nbsp; mergeMaps
##### &nbsp;&nbsp;&nbsp; `mergeMaps`

&nbsp;&nbsp;&nbsp; Type: `false | (values: Map<unknown, unknown>[], utils: DeepMergeMergeFunctionUtils) => unknown`

&nbsp;&nbsp;&nbsp; If false, maps won't be merged. If set to a function, that function will be used to merge maps.

##### &nbsp;&nbsp;&nbsp; mergeSets
##### &nbsp;&nbsp;&nbsp; `mergeSets`

&nbsp;&nbsp;&nbsp; Type: `false | (values: Set<unknown>[], utils: DeepMergeMergeFunctionUtils) => unknown`

&nbsp;&nbsp;&nbsp; If false, sets won't be merged. If set to a function, that function will be used to merge sets.

##### &nbsp;&nbsp;&nbsp; mergeOthers
##### &nbsp;&nbsp;&nbsp; `mergeOthers`

&nbsp;&nbsp;&nbsp; Type: `(values: Set<unknown>[], utils: DeepMergeMergeFunctionUtils) => unknown`

Expand All @@ -153,16 +153,16 @@ Generate a customized deepmerge function using the given options. The returned f

&nbsp; This is a set of utility functions that are made available to your custom merge functions.

##### &nbsp;&nbsp;&nbsp; mergeFunctions
##### &nbsp;&nbsp;&nbsp; `mergeFunctions`

&nbsp;&nbsp;&nbsp; These are all the merge function being used to perform the deepmerge.\
&nbsp;&nbsp;&nbsp; These will be the custom merge functions you gave, or the default merge functions for options you didn't customize.

##### &nbsp;&nbsp;&nbsp; defaultMergeFunctions
##### &nbsp;&nbsp;&nbsp; `defaultMergeFunctions`

&nbsp;&nbsp;&nbsp; These are all the merge functions that the default, non-customize deepmerge function uses.

##### &nbsp;&nbsp;&nbsp; deepmerge
##### &nbsp;&nbsp;&nbsp; `deepmerge`

&nbsp;&nbsp;&nbsp; This is your top level customized deepmerge function.

Expand Down

0 comments on commit 4943b87

Please sign in to comment.