Liking cljdoc? Tell your friends :D

js.Symbol

The data type symbol is a primitive data type. The Symbol() function a value of type symbol, has static properties that expose several of built-in objects, has static methods that expose the global registry, and resembles a built-in object class but is incomplete a constructor because it does not support the syntax "new Symbol()".

The data type symbol is a primitive data type. The Symbol() function
a value of type symbol, has static properties that expose several
of built-in objects, has static methods that expose the global
registry, and resembles a built-in object class but is incomplete
a constructor because it does not support the syntax \"new Symbol()\".
raw docstring

async-iteratorcljs

(async-iterator this)

Property.

The Symbol.asyncIterator well-known symbol specifies the default for an object. If this property is set on an object, it is an iterable and can be used in a for await...of loop.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/asyncIterator

Property.

The Symbol.asyncIterator well-known symbol specifies the default
for an object. If this property is set on an object, it is an
iterable and can be used in a for await...of loop.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/asyncIterator`
sourceraw docstring

descriptioncljs

(description this)

Property.

[Read Only]

The read-only description property is a string returning the description of js.Symbol objects.

Symbol('myDescription').description; Symbol.iterator.description; Symbol.for('foo').description;

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/description

Property.

[Read Only]

The read-only description property is a string returning the
description of `js.Symbol` objects.

`Symbol('myDescription').description;
Symbol.iterator.description;
Symbol.for('foo').description;`

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/description`
sourceraw docstring

forcljs

(for this key)

Method.

The Symbol.for(key) method searches for existing symbols in a symbol registry with the given key and returns it if found. Otherwise new symbol gets created in the global symbol registry with this

Symbol.for(key);

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/for

Method.

The Symbol.for(key) method searches for existing symbols in a
symbol registry with the given key and returns it if found. Otherwise
new symbol gets created in the global symbol registry with this

`Symbol.for(key);`

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/for`
sourceraw docstring

has-instancecljs

(has-instance this)

Property.

The Symbol.hasInstance well-known symbol is used to determine a constructor object recognizes an object as its instance. The operator's behavior can be customized by this symbol.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/hasInstance

Property.

The Symbol.hasInstance well-known symbol is used to determine
a constructor object recognizes an object as its instance. The
operator's behavior can be customized by this symbol.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/hasInstance`
sourceraw docstring

is-concat-spreadablecljs

(is-concat-spreadable this)

Property.

The Symbol.isConcatSpreadable well-known symbol is used to configure an object should be flattened to its array elements when using Array.prototype.concat() method.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/isConcatSpreadable

Property.

The Symbol.isConcatSpreadable well-known symbol is used to configure
an object should be flattened to its array elements when using
`Array.prototype.concat()` method.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/isConcatSpreadable`
sourceraw docstring

iteratorcljs

(iterator this)

Property.

The Symbol.iterator well-known symbol specifies the default iterator an object. Used by for...of.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/iterator

Property.

The Symbol.iterator well-known symbol specifies the default iterator
an object. Used by `for...of`.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/iterator`
sourceraw docstring

key-forcljs

(key-for this sym)

Method.

The Symbol.keyFor(sym) method retrieves a shared symbol key from global symbol registry for the given symbol.

Symbol.keyFor(sym);

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/keyFor

Method.

The Symbol.keyFor(sym) method retrieves a shared symbol key from
global symbol registry for the given symbol.

`Symbol.keyFor(sym);`

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/keyFor`
sourceraw docstring

lengthcljs

(length this)

Property.

Length property whose value is 0.

Property.

Length property whose value is 0.
sourceraw docstring

matchcljs

(match this)

Property.

The Symbol.match well-known symbol specifies the matching of regular expression against a string. This function is called the String.prototype.match() method.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/match

Property.

The Symbol.match well-known symbol specifies the matching of
regular expression against a string. This function is called
the `String.prototype.match()` method.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/match`
sourceraw docstring

match-allcljs

(match-all this)

Property.

The Symbol.matchAll well-known symbol returns an iterator, that matches of the regular expression against a string. This function called by the String.prototype.matchAll() method.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/matchAll

Property.

The Symbol.matchAll well-known symbol returns an iterator, that
matches of the regular expression against a string. This function
called by the `String.prototype.matchAll()` method.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/matchAll`
sourceraw docstring

prototypecljs

(prototype this)

Property.

The Symbol.prototype property represents the prototype for the constructor.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/prototype

Property.

The Symbol.prototype property represents the prototype for the
constructor.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/prototype`
sourceraw docstring

replacecljs

(replace this)

Property.

The Symbol.replace well-known symbol specifies the method that matched substrings of a string. This function is called by the method.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/replace

Property.

The Symbol.replace well-known symbol specifies the method that
matched substrings of a string. This function is called by the
method.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/replace`
sourceraw docstring

(search this)

Property.

The Symbol.search well-known symbol specifies the method that the index within a string that matches the regular expression. function is called by the String.prototype.search() method.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/search

Property.

The Symbol.search well-known symbol specifies the method that
the index within a string that matches the regular expression.
function is called by the `String.prototype.search()` method.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/search`
sourceraw docstring

set-async-iterator!cljs

(set-async-iterator! this val)

Property.

The Symbol.asyncIterator well-known symbol specifies the default for an object. If this property is set on an object, it is an iterable and can be used in a for await...of loop.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/asyncIterator

Property.

The Symbol.asyncIterator well-known symbol specifies the default
for an object. If this property is set on an object, it is an
iterable and can be used in a for await...of loop.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/asyncIterator`
sourceraw docstring

set-has-instance!cljs

(set-has-instance! this val)

Property.

The Symbol.hasInstance well-known symbol is used to determine a constructor object recognizes an object as its instance. The operator's behavior can be customized by this symbol.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/hasInstance

Property.

The Symbol.hasInstance well-known symbol is used to determine
a constructor object recognizes an object as its instance. The
operator's behavior can be customized by this symbol.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/hasInstance`
sourceraw docstring

set-is-concat-spreadable!cljs

(set-is-concat-spreadable! this val)

Property.

The Symbol.isConcatSpreadable well-known symbol is used to configure an object should be flattened to its array elements when using Array.prototype.concat() method.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/isConcatSpreadable

Property.

The Symbol.isConcatSpreadable well-known symbol is used to configure
an object should be flattened to its array elements when using
`Array.prototype.concat()` method.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/isConcatSpreadable`
sourceraw docstring

set-iterator!cljs

(set-iterator! this val)

Property.

The Symbol.iterator well-known symbol specifies the default iterator an object. Used by for...of.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/iterator

Property.

The Symbol.iterator well-known symbol specifies the default iterator
an object. Used by `for...of`.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/iterator`
sourceraw docstring

set-length!cljs

(set-length! this val)

Property.

Length property whose value is 0.

Property.

Length property whose value is 0.
sourceraw docstring

set-match!cljs

(set-match! this val)

Property.

The Symbol.match well-known symbol specifies the matching of regular expression against a string. This function is called the String.prototype.match() method.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/match

Property.

The Symbol.match well-known symbol specifies the matching of
regular expression against a string. This function is called
the `String.prototype.match()` method.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/match`
sourceraw docstring

set-match-all!cljs

(set-match-all! this val)

Property.

The Symbol.matchAll well-known symbol returns an iterator, that matches of the regular expression against a string. This function called by the String.prototype.matchAll() method.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/matchAll

Property.

The Symbol.matchAll well-known symbol returns an iterator, that
matches of the regular expression against a string. This function
called by the `String.prototype.matchAll()` method.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/matchAll`
sourceraw docstring

set-prototype!cljs

(set-prototype! this val)

Property.

The Symbol.prototype property represents the prototype for the constructor.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/prototype

Property.

The Symbol.prototype property represents the prototype for the
constructor.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/prototype`
sourceraw docstring

set-replace!cljs

(set-replace! this val)

Property.

The Symbol.replace well-known symbol specifies the method that matched substrings of a string. This function is called by the method.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/replace

Property.

The Symbol.replace well-known symbol specifies the method that
matched substrings of a string. This function is called by the
method.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/replace`
sourceraw docstring

set-search!cljs

(set-search! this val)

Property.

The Symbol.search well-known symbol specifies the method that the index within a string that matches the regular expression. function is called by the String.prototype.search() method.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/search

Property.

The Symbol.search well-known symbol specifies the method that
the index within a string that matches the regular expression.
function is called by the `String.prototype.search()` method.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/search`
sourceraw docstring

set-species!cljs

(set-species! this val)

Property.

The well-known symbol Symbol.species specifies a function-valued that the constructor function uses to create derived objects.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/species

Property.

The well-known symbol Symbol.species specifies a function-valued
that the constructor function uses to create derived objects.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/species`
sourceraw docstring

set-split!cljs

(set-split! this val)

Property.

The Symbol.split well-known symbol specifies the method that a string at the indices that match a regular expression. This is called by the String.prototype.split() method.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/split

Property.

The Symbol.split well-known symbol specifies the method that
a string at the indices that match a regular expression. This
is called by the `String.prototype.split()` method.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/split`
sourceraw docstring

set-to-primitive!cljs

(set-to-primitive! this val)

Property.

The Symbol.toPrimitive is a symbol that specifies a function property that is called to convert an object to a corresponding value.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toPrimitive

Property.

The Symbol.toPrimitive is a symbol that specifies a function
property that is called to convert an object to a corresponding
value.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toPrimitive`
sourceraw docstring

set-to-string-tag!cljs

(set-to-string-tag! this val)

Property.

The Symbol.toStringTag well-known symbol is a string valued property is used in the creation of the default string description of object. It is accessed internally by the Object.prototype.toString()

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag

Property.

The Symbol.toStringTag well-known symbol is a string valued property
is used in the creation of the default string description of
object. It is accessed internally by the `Object.prototype.toString()`

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag`
sourceraw docstring

set-unscopables!cljs

(set-unscopables! this val)

Property.

The Symbol.unscopables well-known symbol is used to specify an value of whose own and inherited property names are excluded the with environment bindings of the associated object.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/unscopables

Property.

The Symbol.unscopables well-known symbol is used to specify an
value of whose own and inherited property names are excluded
the with environment bindings of the associated object.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/unscopables`
sourceraw docstring

speciescljs

(species this)

Property.

The well-known symbol Symbol.species specifies a function-valued that the constructor function uses to create derived objects.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/species

Property.

The well-known symbol Symbol.species specifies a function-valued
that the constructor function uses to create derived objects.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/species`
sourceraw docstring

splitcljs

(split this)

Property.

The Symbol.split well-known symbol specifies the method that a string at the indices that match a regular expression. This is called by the String.prototype.split() method.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/split

Property.

The Symbol.split well-known symbol specifies the method that
a string at the indices that match a regular expression. This
is called by the `String.prototype.split()` method.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/split`
sourceraw docstring

to-primitivecljs

(to-primitive this)

Property.

The Symbol.toPrimitive is a symbol that specifies a function property that is called to convert an object to a corresponding value.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toPrimitive

Property.

The Symbol.toPrimitive is a symbol that specifies a function
property that is called to convert an object to a corresponding
value.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toPrimitive`
sourceraw docstring

to-sourcecljs

(to-source this & args)

Method.

[Non Standard]

The toSource() method returns a string representing the source of the object.

`Symbol.toSource()

var sym = Symbol() sym.toSource()`

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toSource

Method.

[Non Standard]

The toSource() method returns a string representing the source
of the object.

`Symbol.toSource()

var sym = Symbol()
sym.toSource()`

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toSource`
sourceraw docstring

to-stringcljs

(to-string this & args)

Method.

The toString() method returns a string representing the specified object.

Symbol().toString();

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toString

Method.

The toString() method returns a string representing the specified
object.

`Symbol().toString();`

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toString`
sourceraw docstring

to-string-tagcljs

(to-string-tag this)

Property.

The Symbol.toStringTag well-known symbol is a string valued property is used in the creation of the default string description of object. It is accessed internally by the Object.prototype.toString()

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag

Property.

The Symbol.toStringTag well-known symbol is a string valued property
is used in the creation of the default string description of
object. It is accessed internally by the `Object.prototype.toString()`

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/toStringTag`
sourceraw docstring

unscopablescljs

(unscopables this)

Property.

The Symbol.unscopables well-known symbol is used to specify an value of whose own and inherited property names are excluded the with environment bindings of the associated object.

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/unscopables

Property.

The Symbol.unscopables well-known symbol is used to specify an
value of whose own and inherited property names are excluded
the with environment bindings of the associated object.

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/unscopables`
sourceraw docstring

value-ofcljs

(value-of this & args)

Method.

The valueOf() method returns the primitive value of a Symbol

Symbol().valueOf();

See also: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/valueOf

Method.

The valueOf() method returns the primitive value of a Symbol

`Symbol().valueOf();`

See also: `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol/valueOf`
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close