ObjectStore#

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

Properties#

autoIncrement no setter#

bool? get autoIncrement native;

hashCode no setter inherited#

Inherited from Interceptor.

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

indexNames no setter#

@Returns('DomStringList')
@Creates('DomStringList')
List<String>? get indexNames native;

keyPath no setter#

@annotation_Creates_SerializedScriptValue
Object? get keyPath native;

name read / write#

String? get name native;

set name(String? value) native;

runtimeType no setter inherited#

Inherited from Interceptor.

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

transaction no setter#

Transaction? get transaction native;

Methods#

add()#

Future add(value, [key]) {
  try {
    var request;
    if (key != null) {
      request = _add(value, key);
    } else {
      request = _add(value);
    }
    return _completeRequest(request);
  } catch (e, stacktrace) {
    return new Future.error(e, stacktrace);
  }
}

clear()#

Future clear() {
  try {
    return _completeRequest(_clear());
  } catch (e, stacktrace) {
    return new Future.error(e, stacktrace);
  }
}

count()#

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);
  }
}

createIndex()#

Index createIndex(String name, keyPath, {bool? unique, bool? multiEntry}) {
  var options = {};
  if (unique != null) {
    options['unique'] = unique;
  }
  if (multiEntry != null) {
    options['multiEntry'] = multiEntry;
  }

  return _createIndex(name, keyPath, options);
}

delete()#

Future delete(key_OR_keyRange) {
  try {
    return _completeRequest(_delete(key_OR_keyRange));
  } catch (e, stacktrace) {
    return new Future.error(e, stacktrace);
  }
}

deleteIndex()#

void deleteIndex(String name) native;

getAll()#

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

getAllKeys()#

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

getKey()#

Request getKey(Object key) native;

getObject()#

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

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

index()#

Index index(String name) native;

noSuchMethod() inherited#

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.

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

openCursor()#

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

The stream must be manually advanced by calling Cursor.next after each item or by specifying autoAdvance to be true.

var cursors = objectStore.openCursor().listen(
  (cursor) {
    // ...some processing with the cursor
    cursor.next(); // advance onto the next cursor.
  },
  onDone: () {
    // called when there are no more cursors.
    print('all done!');
  });

Asynchronous operations which are not related to the current transaction will cause the transaction to automatically be committed-- all processing must be done synchronously unless they are additional async requests to the current transaction.

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;
  }

  &#47;&#47; TODO: try&#47;catch this and return a stream with an immediate error.
  var request;
  if (direction == null) {
    request = _openCursor(key_OR_range);
  } else {
    request = _openCursor(key_OR_range, direction);
  }
  return _cursorStreamFromResult(request, autoAdvance);
}

openKeyCursor()#

Request openKeyCursor(Object? range, [String? direction]) native;

put()#

Future put(value, [key]) {
  try {
    var request;
    if (key != null) {
      request = _put(value, key);
    } else {
      request = _put(value);
    }
    return _completeRequest(request);
  } catch (e, stacktrace) {
    return new Future.error(e, stacktrace);
  }
}

toString() inherited#

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.

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

Operators#

operator ==() inherited#

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.

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