ItemPropertiesCompress

Callable

• ItemPropertiesCompress(item, options): ItemPropertiesMinimized

---

• Compress the passed item's properties in preparation for ItemBundle creation.

  ---

  Parameters

  • item: Item

    The item whose properties are to be minimized

  • optionaloptions: { allowLocks: boolean; omit: Iterable<keyof ItemProperties, any, any> } = undefined

  • allowLocks: boolean

    Whether to return lock-specific options and properties if present

  • omit: Iterable<keyof ItemProperties, any, any>

    Properties that should always be omitted

  Returns ItemPropertiesMinimized

  The minimized item properties