Class UniqueIndex

Hierarchy

UniqueIndex

Index

Constructors

constructor

Methods

Constructors

constructor

new UniqueIndex(propertyField: string): UniqueIndex

- Defined in loki/src/unique_index.ts:10
Constructs an unique index object.

Parameters
- propertyField: string
  
  the property field to index
Returns UniqueIndex

Methods

clear

clear(): void

- Defined in loki/src/unique_index.ts:88
Clears the unique index.

Returns void

get

get(value: any): number

- Defined in loki/src/unique_index.ts:47
Returns the $loki id of an unique value.

Parameters
- value: any
  
  the value to retrieve a loki id match for
Returns number

remove

remove(id: number): void

- Defined in loki/src/unique_index.ts:74
Removes an unique index.

Parameters
- id: number
  
  (loki) id to remove from index
Returns void

set

set(id: number, value: any): void

- Defined in loki/src/unique_index.ts:27
Sets a document's unique index.

Parameters
- id: number
  
  loki id to associate with value
- value: any
  
  value to associate with id
Returns void

update

update(id: number, value: any): void

- Defined in loki/src/unique_index.ts:56
Updates a document's unique index.

Parameters
- id: number
  
  (loki) id of document to update the value to
- value: any
  
  value to associate with loki id
Returns void

Generated using TypeDoc