Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ReactiveIDBIndex<T>

Type parameters

  • T = unknown

Hierarchy

  • ReactiveIDBIndex

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly objectStore

objectStore: ReactiveIDBObjectStore<T>

Accessors

keyPath

  • get keyPath(): string | string[]

multiEntry

  • get multiEntry(): boolean

name

  • get name(): string

unique

  • get unique(): boolean

Methods

count$

  • count$(key?: string | number | Date | ArrayBufferView | ArrayBuffer | IDBArrayKey | IDBKeyRange): Observable<number>

  • Retrieves the number of records matching the given key or key range in query.

    If successful, request's result will be the count.

    Parameters

    • Optional key: string | number | Date | ArrayBufferView | ArrayBuffer | IDBArrayKey | IDBKeyRange

    Returns Observable<number>

get$

  • get$(key: string | number | Date | ArrayBufferView | ArrayBuffer | IDBArrayKey | IDBKeyRange): Observable<undefined | T>

  • Retrieves the value of the first record matching the given key or key range in query.

    If successful, request's result will be the value, or undefined if there was no matching record.

    Parameters

    • key: string | number | Date | ArrayBufferView | ArrayBuffer | IDBArrayKey | IDBKeyRange

    Returns Observable<undefined | T>

getAll$

  • getAll$(query?: null | string | number | Date | ArrayBufferView | ArrayBuffer | IDBArrayKey | IDBKeyRange, count?: number): Observable<T[]>

  • Retrieves the values of the records matching the given key or key range in query (up to count if given).

    If successful, request's result will be an Array of the values.

    Parameters

    • Optional query: null | string | number | Date | ArrayBufferView | ArrayBuffer | IDBArrayKey | IDBKeyRange
    • Optional count: number

    Returns Observable<T[]>

getAllKeys$

  • getAllKeys$(query?: null | string | number | Date | ArrayBufferView | ArrayBuffer | IDBArrayKey | IDBKeyRange, count?: number): Observable<IDBValidKey[]>

  • Retrieves the keys of records matching the given key or key range in query (up to count if given).

    If successful, request's result will be an Array of the keys.

    Parameters

    • Optional query: null | string | number | Date | ArrayBufferView | ArrayBuffer | IDBArrayKey | IDBKeyRange
    • Optional count: number

    Returns Observable<IDBValidKey[]>

getKey$

  • getKey$(key: string | number | Date | ArrayBufferView | ArrayBuffer | IDBArrayKey | IDBKeyRange): Observable<undefined | string | number | Date | ArrayBufferView | ArrayBuffer | IDBArrayKey>

  • Retrieves the key of the first record matching the given key or key range in query.

    If successful, request's result will be the key, or undefined if there was no matching record.

    Parameters

    • key: string | number | Date | ArrayBufferView | ArrayBuffer | IDBArrayKey | IDBKeyRange

    Returns Observable<undefined | string | number | Date | ArrayBufferView | ArrayBuffer | IDBArrayKey>

openCursor$

  • openCursor$(query?: null | string | number | Date | ArrayBufferView | ArrayBuffer | IDBArrayKey | IDBKeyRange, direction?: "next" | "nextunique" | "prev" | "prevunique"): Observable<null | IDBCursorWithValue>

  • Opens a cursor over the records matching query, ordered by direction. If query is null, all records in index are matched.

    If successful, request's result will be an IDBCursorWithValue, or null if there were no matching records.

    Parameters

    • Optional query: null | string | number | Date | ArrayBufferView | ArrayBuffer | IDBArrayKey | IDBKeyRange
    • Optional direction: "next" | "nextunique" | "prev" | "prevunique"

    Returns Observable<null | IDBCursorWithValue>

openKeyCursor$

  • openKeyCursor$(query?: null | string | number | Date | ArrayBufferView | ArrayBuffer | IDBArrayKey | IDBKeyRange, direction?: "next" | "nextunique" | "prev" | "prevunique"): Observable<null | IDBCursor>

  • Opens a cursor with key only flag set over the records matching query, ordered by direction. If query is null, all records in index are matched.

    If successful, request's result will be an IDBCursor, or null if there were no matching records.

    Parameters

    • Optional query: null | string | number | Date | ArrayBufferView | ArrayBuffer | IDBArrayKey | IDBKeyRange
    • Optional direction: "next" | "nextunique" | "prev" | "prevunique"

    Returns Observable<null | IDBCursor>

Generated using TypeDoc