Observable API
The map() method of the Observable interface returns a new observable that emits the values of the source observable, each transformed by a mapping function.
Syntax
map(mapper)
Parameters
mapper- : A function to execute for each value emitted by the source observable. Its return value is emitted by the returned observable. The function is called with the following arguments:
value- : The current value being processed.
index- : The index of the current value being processed, starting from
0.
- : The index of the current value being processed, starting from
- : A function to execute for each value emitted by the source observable. Its return value is emitted by the returned observable. The function is called with the following arguments:
Return value
A new Observable. When subscribed to, it calls mapper for each value emitted by the source observable and emits the return value. When the source completes, the returned observable also completes.
Description
Like other observable-returning operators, this method is lazy: calling it creates a new observable without subscribing to the source. Processing starts when the returned observable is subscribed to.
If mapper throws an exception, the returned observable errors and unsubscribes from the source. Errors from the source are also forwarded.
The return value of mapper is emitted as-is. In particular, a returned promise is emitted as a promise object; it is not awaited. To emit values from a returned promise or another observable, use Observable.flatMap or Observable.switchMap.
Examples
Using map()
This example displays the mouse coordinates when the pointer moves over either of two <div> elements. The mapping function extracts the coordinates from each mouse event into an object with x and y properties.
<div></div>
<div></div>
<p></p>
div {
height: 120px;
background-color: purple;
margin-bottom: 40px;
}
const outputElem = document.querySelector("p");
document.body
.when("mousemove")
.filter((e) => e.target.matches("div"))
.map((e) => ({ x: e.clientX, y: e.clientY }))
.subscribe({ next: reportCoords });
function reportCoords(e) {
outputElem.textContent = `${e.x},${e.y}`;
}
basic-map
Specifications
Browser compatibility
See also
- Observable.flatMap()
- Using observables
- Observable explainer
来源:MDN Web Docs / Mozilla 贡献者 · 作者与贡献记录 · CC BY-SA 2.5。离线整理了版式、链接和媒体显示。
