$$merge

Merge multiple objects into one. Allows deep merging and array concatenation.

Usage

{ 
  "$$merge": /* Array of objects to merge */,
  "deep": false /* boolean */,
  "arrays": false /* boolean */
}

"$$merge([deep],[arrays]):{input}"

note

Concrete values in the usage example are default values.

Returns

The merged schema of all specified objects

Arguments

Argument	Type	Values	Required / Default Value	Description
Primary	array		Yes	Array of objects to merge
deep	boolean	false/true	false	Whether to merge objects deeply
arrays	boolean	false/true	false	Whether to concatenate arrays

Examples

Input

Definition

Output

{
  "a": "A"
}

{
  "$$merge": [
    "$",
    {
      "b": "B"
    }
  ]
}

{
  "a": "A",
  "b": "B"
}

Test

{
  "a": "A",
  "b": "B"
}

{
  "$$merge": [
    "$",
    {
      "b": "BB"
    }
  ]
}

{
  "a": "A",
  "b": "BB"
}

Test

{
  "a": "A",
  "b": "B"
}

{
  "$$merge": [
    "$",
    {
      "b": "#null"
    }
  ]
}

{
  "a": "A",
  "b": null
}

Test

{
  "a": {
    "aa": "AA"
  },
  "b": "B"
}

{
  "$$merge": [
    "$",
    {
      "a": {
        "aaa": "AAA"
      }
    }
  ]
}

{
  "a": {
    "aaa": "AAA"
  },
  "b": "B"
}

Test

{
  "a": {
    "aa": "AA"
  },
  "b": "B"
}

{
  "$$merge": [
    "$",
    {
      "a": {
        "aaa": "AAA"
      }
    }
  ],
  "deep": true
}

{
  "a": {
    "aa": "AA",
    "aaa": "AAA"
  },
  "b": "B"
}

Test

{
  "a": {
    "aa": "AA"
  },
  "c": [
    1,
    2
  ]
}

{
  "$$merge": [
    "$",
    {
      "a": {
        "aaa": "AAA"
      },
      "c": [
        3,
        4
      ]
    }
  ],
  "deep": true,
  "arrays": true
}

{
  "a": {
    "aa": "AA",
    "aaa": "AAA"
  },
  "c": [
    1,
    2,
    3,
    4
  ]
}

Test

{
  "a": {
    "aa": "AA"
  },
  "c": [
    1,
    2
  ]
}

{
  "$$merge": [
    "$",
    {
      "a": {
        "aaa": "AAA"
      },
      "c": [
        3,
        4
      ]
    }
  ],
  "arrays": true
}

{
  "a": {
    "aaa": "AAA"
  },
  "c": [
    1,
    2,
    3,
    4
  ]
}

Test