JsFunction#

A proxy on a JavaScript Function object.

Constructors#

JsFunction.withThis() factory#

Returns a JsFunction that captures its 'this' binding and calls f with the value of JavaScript this passed as the first argument.

external factory JsFunction.withThis(Function f);

Properties#

hashCode no setter inherited#

The hash code for this object.

A hash code is a single integer which represents the state of the object that affects operator == comparisons.

All objects have hash codes. The default hash code implemented by Object represents only the identity of the object, the same way as the default operator == implementation only considers objects equal if they are identical (see identityHashCode).

If operator == is overridden to use the object state instead, the hash code must also be changed to represent that state, otherwise the object cannot be used in hash based data structures like the default Set and Map implementations.

Hash codes must be the same for objects that are equal to each other according to operator ==. The hash code of an object should only change if the object changes in a way that affects equality. There are no further requirements for the hash codes. They need not be consistent between executions of the same program and there are no distribution guarantees.

Objects that are not equal are allowed to have the same hash code. It is even technically allowed that all instances have the same hash code, but if clashes happen too often, it may reduce the efficiency of hash-based data structures like HashSet or HashMap.

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

Inherited from JsObject.

int get hashCode => 0;

runtimeType no setter inherited#

A representation of the runtime type of the object.

Inherited from Object.

external Type get runtimeType;

Methods#

apply()#

Invokes the JavaScript function with arguments args. If thisArg is supplied it is the value of this for the invocation.

external dynamic apply(List args, {thisArg});

callMethod() inherited#

Calls method on the JavaScript object with the arguments args and returns the result.

The type of method must be either String or num.

Inherited from JsObject.

external dynamic callMethod(Object method, [List? args]);

deleteProperty() inherited#

Removes property from the JavaScript object.

This is the equivalent of the delete operator in JavaScript.

Inherited from JsObject.

external void deleteProperty(Object property);

hasProperty() inherited#

Returns true if the JavaScript object contains the specified property either directly or though its prototype chain.

This is the equivalent of the in operator in JavaScript.

Inherited from JsObject.

external bool hasProperty(Object property);

instanceof() inherited#

Returns true if the JavaScript object has type in its prototype chain.

This is the equivalent of the instanceof operator in JavaScript.

Inherited from JsObject.

external bool instanceof(JsFunction type);

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 Object.

@pragma("vm:entry-point")
@pragma("wasm:entry-point")
external dynamic noSuchMethod(Invocation invocation);

toString() inherited#

Returns the result of the JavaScript objects toString method.

Inherited from JsObject.

external String toString();

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 JsObject.

external bool operator ==(Object other);

operator []() inherited#

Returns the value associated with property from the proxied JavaScript object.

The type of property must be either String or num.

Inherited from JsObject.

external dynamic operator [](Object property);

operator []=() inherited#

Inherited from JsObject.

external void operator []=(Object property, Object? value);