Index

class Index extends JavaScriptObject

Annotations: @Unstable.new(), @Native.new("IDBIndex")

Properties

hashCode no setter inherited

int get hashCode

Inherited from Interceptor.

Implementation

int get hashCode => Primitives.objectHashCode(this);

keyPath no setter

Object? get keyPath

Implementation

@annotation_Creates_SerializedScriptValue
Object? get keyPath native;

multiEntry no setter

bool? get multiEntry

Implementation

bool? get multiEntry native;

name read / write

String? get name

Implementation

String? get name native;

set name(String? value) native;

objectStore no setter

ObjectStore? get objectStore

Implementation

ObjectStore? get objectStore native;

runtimeType no setter inherited

Type get runtimeType

Inherited from Interceptor.

Implementation

Type get runtimeType =>
    getRuntimeTypeOfInterceptorNotArray(getInterceptor(this), this);

unique no setter

bool? get unique

Implementation

bool? get unique native;

Methods

count()

Future<int> count([dynamic key_OR_range])

Implementation

Future<int> count([key_OR_range]) {
  try {
    var request = _count(key_OR_range);
    return _completeRequest(request);
  } catch (e, stacktrace) {
    return new Future.error(e, stacktrace);
  }
}

get()

Future<dynamic> get(dynamic key)

Implementation

Future get(key) {
  try {
    var request = _get(key);

    return _completeRequest(request);
  } catch (e, stacktrace) {
    return new Future.error(e, stacktrace);
  }
}

getAll()

Request getAll(Object? query, [int? count])

Implementation

Request getAll(Object? query, [int? count]) native;

getAllKeys()

Request getAllKeys(Object? query, [int? count])

Implementation

Request getAllKeys(Object? query, [int? count]) native;

getKey()

Future<dynamic> getKey(dynamic key)

Implementation

Future getKey(key) {
  try {
    var request = _getKey(key);

    return _completeRequest(request);
  } catch (e, stacktrace) {
    return new Future.error(e, stacktrace);
  }
}

noSuchMethod() inherited

dynamic noSuchMethod(Invocation invocation)

Invoked when a nonexistent method or property is accessed.

A dynamic member invocation can attempt to call a member which doesn't exist on the receiving object. Example:

dynamic object = 1;
object.add(42); // Statically allowed, run-time error

This invalid code will invoke the noSuchMethod method of the integer 1 with an Invocation representing the .add(42) call and arguments (which then throws).

Classes can override noSuchMethod to provide custom behavior for such invalid dynamic invocations.

A class with a non-default noSuchMethod invocation can also omit implementations for members of its interface. Example:

class MockList<T> implements List<T> {
  noSuchMethod(Invocation invocation) {
    log(invocation);
    super.noSuchMethod(invocation); // Will throw.
  }
}
void main() {
  MockList().add(42);
}

This code has no compile-time warnings or errors even though the MockList class has no concrete implementation of any of the List interface methods. Calls to List methods are forwarded to noSuchMethod, so this code will log an invocation similar to Invocation.method(#add, [42]) and then throw.

If a value is returned from noSuchMethod, it becomes the result of the original invocation. If the value is not of a type that can be returned by the original invocation, a type error occurs at the invocation.

The default behavior is to throw a NoSuchMethodError.

Inherited from Interceptor.

Implementation

dynamic noSuchMethod(Invocation invocation) {
  throw NoSuchMethodError.withInvocation(this, invocation);
}

openCursor()

Stream<CursorWithValue> openCursor({
  dynamic key,
  KeyRange? range,
  String? direction,
  bool? autoAdvance,
})

Creates a stream of cursors over the records in this object store.

See also:

• ObjectStore.openCursor

Implementation

Stream<CursorWithValue> openCursor({
  key,
  KeyRange? range,
  String? direction,
  bool? autoAdvance,
}) {
  var key_OR_range = null;
  if (key != null) {
    if (range != null) {
      throw new ArgumentError('Cannot specify both key and range.');
    }
    key_OR_range = key;
  } else {
    key_OR_range = range;
  }
  var request;
  if (direction == null) {
    &#47;&#47; FIXME: Passing in "next" should be unnecessary.
    request = _openCursor(key_OR_range, "next");
  } else {
    request = _openCursor(key_OR_range, direction);
  }
  return ObjectStore._cursorStreamFromResult(request, autoAdvance);
}

openKeyCursor()

Stream<Cursor> openKeyCursor({
  dynamic key,
  KeyRange? range,
  String? direction,
  bool? autoAdvance,
})

Creates a stream of cursors over the records in this object store.

See also:

• ObjectStore.openCursor

Implementation

Stream<Cursor> openKeyCursor({
  key,
  KeyRange? range,
  String? direction,
  bool? autoAdvance,
}) {
  var key_OR_range = null;
  if (key != null) {
    if (range != null) {
      throw new ArgumentError('Cannot specify both key and range.');
    }
    key_OR_range = key;
  } else {
    key_OR_range = range;
  }
  var request;
  if (direction == null) {
    &#47;&#47; FIXME: Passing in "next" should be unnecessary.
    request = _openKeyCursor(key_OR_range, "next");
  } else {
    request = _openKeyCursor(key_OR_range, direction);
  }
  return ObjectStore._cursorStreamFromResult(request, autoAdvance);
}

toString() inherited

String toString()

A string representation of this object.

Some classes have a default textual representation, often paired with a static parse function (like int.parse). These classes will provide the textual representation as their string representation.

Other classes have no meaningful textual representation that a program will care about. Such classes will typically override toString to provide useful information when inspecting the object, mainly for debugging or logging.

Inherited from Interceptor.

Implementation

String toString() => Primitives.objectToHumanReadableString(this);

Operators

operator ==() inherited

bool operator ==(Object other)

The equality operator.

The default behavior for all Objects is to return true if and only if this object and other are the same object.

Override this method to specify a different equality relation on a class. The overriding method must still be an equivalence relation. That is, it must be:

• Total: It must return a boolean for all arguments. It should never throw.

• Reflexive: For all objects o, o == o must be true.

• Symmetric: For all objects o1 and o2, o1 == o2 and o2 == o1 must either both be true, or both be false.

• Transitive: For all objects o1, o2, and o3, if o1 == o2 and o2 == o3 are true, then o1 == o3 must be true.

The method should also be consistent over time, so whether two objects are equal should only change if at least one of the objects was modified.

If a subclass overrides the equality operator, it should override the hashCode method as well to maintain consistency.

Inherited from Interceptor.

Implementation

bool operator ==(Object other) => identical(this, other);