Interface Index

Callable

• Index(spec: IndexSpecification, options?: MongoDB.IndexOptions): (Anonymous function)

• Specifies a MongoDB collection level index to be managed by Iridium for this instance type. More than one instance of this decorator may be used if you wish to specify multiple indexes.

  Parameters

  • spec: IndexSpecification

    The formal index specification which defines the properties and ordering used in the index.

  • Optional options: MongoDB.IndexOptions

    The options dictating the way in which the index behaves.

    This decorator replaces the use of the static indexes property on instance implementation classes. If your transpiler does not support decorators then you are free to make use of the property instead.

  Returns (Anonymous function)