Symbol class

Available extensions
Annotations
  • @JS()
  • @staticInterop
  • @anonymous

Constructors

Symbol({String? description, String toString$()?, Symbol valueOf()?, Symbol? iterator, Symbol? hasInstance, Symbol? isConcatSpreadable, Symbol? match, Symbol? replace, Symbol? search, Symbol? species, Symbol? split, Symbol? toPrimitive, Symbol? toStringTag, Symbol? unscopables, Symbol? asyncIterator, Symbol? matchAll, Symbol for$(String)?, String? keyFor(Symbol)?})
factory

Properties

description String?

Available on Symbol, provided by the Symbol$Typings extension

Expose the [Description] internal slot of a symbol directly.
no setter
hashCode int
The hash code for this object.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
toString$ String Function()

Available on Symbol, provided by the Symbol$Typings extension

getter/setter pair
valueOf Symbol Function()

Available on Symbol, provided by the Symbol$Typings extension

getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Properties

asyncIterator Symbol
A method that returns the default async iterator for an object. Called by the semantics of the for-await-of statement. A method that returns the default async iterator for an object. Called by the semantics of the for-await-of statement.
no setter
for$ Symbol Function(String)
getter/setter pair
hasInstance Symbol
A method that determines if a constructor object recognizes an object as one of the constructor’s instances. Called by the semantics of the instanceof operator. A method that determines if a constructor object recognizes an object as one of the constructor’s instances. Called by the semantics of the instanceof operator.
no setter
isConcatSpreadable Symbol
A Boolean value that if true indicates that an object should flatten to its array elements by Array.prototype.concat. A Boolean value that if true indicates that an object should flatten to its array elements by Array.prototype.concat.
no setter
iterator Symbol
A method that returns the default iterator for an object. Called by the semantics of the for-of statement. A method that returns the default iterator for an object. Called by the semantics of the for-of statement.
no setter
keyFor String? Function(Symbol)
getter/setter pair
match Symbol
A regular expression method that matches the regular expression against a string. Called by the String.prototype.match method. A regular expression method that matches the regular expression against a string. Called by the String.prototype.match method.
no setter
matchAll Symbol
A regular expression method that matches the regular expression against a string. Called by the String.prototype.matchAll method.
no setter
replace Symbol
A regular expression method that replaces matched substrings of a string. Called by the String.prototype.replace method. A regular expression method that replaces matched substrings of a string. Called by the String.prototype.replace method.
no setter
A regular expression method that returns the index within a string that matches the regular expression. Called by the String.prototype.search method. A regular expression method that returns the index within a string that matches the regular expression. Called by the String.prototype.search method.
no setter
species Symbol
A function valued property that is the constructor function that is used to create derived objects. A function valued property that is the constructor function that is used to create derived objects.
no setter
split Symbol
A regular expression method that splits a string at the indices that match the regular expression. Called by the String.prototype.split method. A regular expression method that splits a string at the indices that match the regular expression. Called by the String.prototype.split method.
no setter
toPrimitive Symbol
A method that converts an object to a corresponding primitive value. Called by the ToPrimitive abstract operation. A method that converts an object to a corresponding primitive value. Called by the ToPrimitive abstract operation.
no setter
toStringTag Symbol
A String value that is used in the creation of the default string description of an object. Called by the built-in method Object.prototype.toString. A String value that is used in the creation of the default string description of an object. Called by the built-in method Object.prototype.toString.
no setter
unscopables Symbol
An Object whose own property names are property names that are excluded from the 'with' environment bindings of the associated objects. An Object whose truthy properties are properties that are excluded from the 'with' environment bindings of the associated objects.
no setter