Skip to main content

ItemPropertiesIsSubset

Callable

  • ItemPropertiesIsSubset(subProperties, superProperties, asset, options): { nonEquivalencies: Set<keyof ItemProperties>; result: boolean }

  • Check whether all properties between the passed objects are either equivalent or form a subset of each other (i.e. a non-proper subset)

    Parameters

    • subProperties: ItemProperties

      The (potential) property subset

    • superProperties: ItemProperties

      The (potential) property superset

    • asset: Asset

      The asset

    • optionaloptions: { gatherNonEquivalancies: boolean } = undefined
      • 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 }