Skip to main content

ItemPropertiesCompare

Callable

  • ItemPropertiesCompare(properties1, properties2, asset, options): { nonEquivalencies: Set<keyof ItemProperties>; result: boolean }

  • Check whether all properties between the passed objects are equivalent

    Parameters

    • properties1: ItemProperties

      The first property set

    • properties2: ItemProperties

      The second property set

    • asset: Asset

      The asset

    • optionaloptions: { eqOrSubset: boolean; gatherNonEquivalancies: boolean } = undefined
      • eqOrSubset: boolean

        Whether to check whether the properties are either equivalent or form a (deep) subset of each other (see ItemPropertiesIsSubset). Defaults to false.

      • gatherNonEquivalancies: boolean

        Whether to gather and return the names of all non-equivalent properties. The returned set will always be empty otherwise. Defaults to false.

    Returns { nonEquivalencies: Set<keyof ItemProperties>; result: boolean }