mirror of
https://github.com/josdejong/mathjs.git
synced 2026-01-18 14:59:29 +00:00
56 lines
1.2 KiB
Markdown
56 lines
1.2 KiB
Markdown
# Function select
|
|
|
|
Wrap any value in a Selector, allowing to perform chained operations on
|
|
the value.
|
|
|
|
All methods available in the math.js library can be called upon the selector,
|
|
and then will be evaluated with the value itself as first argument.
|
|
The selector can be closed by executing `selector.done()`, which returns
|
|
the final value.
|
|
|
|
The Selector has a number of special functions:
|
|
|
|
- `done()` Finalize the chained operation and return the selectors value.
|
|
- `valueOf()` The same as `done()`
|
|
- `toString()` Executes `math.format()` onto the selectors value, returning
|
|
a string representation of the value.
|
|
|
|
|
|
## Syntax
|
|
|
|
```js
|
|
math.select(value)
|
|
```
|
|
|
|
### Parameters
|
|
|
|
Parameter | Type | Description
|
|
--------- | ---- | -----------
|
|
`value` | * | A value of any type on which to start a chained operation.
|
|
|
|
### Returns
|
|
|
|
Type | Description
|
|
---- | -----------
|
|
math.chaining.Selector | The created selector
|
|
|
|
|
|
## Examples
|
|
|
|
```js
|
|
math.select(3)
|
|
.add(4)
|
|
.subtract(2)
|
|
.done(); // 5
|
|
|
|
math.select( [[1, 2], [3, 4]] )
|
|
.set([1, 1], 8)
|
|
.multiply(3)
|
|
.done(); // [[24, 6], [9, 12]]
|
|
```
|
|
|
|
|
|
|
|
|
|
<!-- Note: This file is automatically generated from source code comments. Changes made in this file will be overridden. -->
|