Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ItemDefinition

Items in Cosmos DB are simply JSON objects. Most of the Item operations allow for your to provide your own type that extends the very simple ItemDefinition.

You cannot use any reserved keys. You can see the reserved key list in {@link ItemBody}

Hierarchy

  • ItemDefinition

Indexable

[key: string]: any

Items in Cosmos DB are simply JSON objects. Most of the Item operations allow for your to provide your own type that extends the very simple ItemDefinition.

You cannot use any reserved keys. You can see the reserved key list in {@link ItemBody}

Index

Properties

Properties

Optional id

id: string

The id of the item. User settable property. Uniquely identifies the item along with the partition key

Optional ttl

ttl: number

Time to live in seconds for collections with TTL enabled

Generated using TypeDoc