Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface UpdateOptions

Defines the options for an object update operation

export
interface

UpdateOptions

Hierarchy

  • UpdateOptions

Index

Properties

Properties

cache: "nocache" | "noexpiry" | "30sec" | "1min" | "2mins" | "5mins" | "10mins" | "15mins" | "30mins" | "1hour" | "6hours" | "12hours" | "1day" | "1week" | "1month" | "6months" | "1year"

Specify whether to cache the updated object using its id as the cache key or not. If the object is cached and the timeout has expired, the cached object will automatically be removed from the cache.

returnTop: boolean

In case if you update a submodel object (a child object of a top-level object), you can specify whether to return the newly updated child object or the updated top-level object.

Generated using TypeDoc