Symbol.iterator

Try it

const iterable = {};

iterable[Symbol.iterator] = function* () {
  yield 1;
  yield 2;
  yield 3;
};

console.log([...iterable]);
// Expected output: Array [1, 2, 3]

Giá trị

Well-known symbol Symbol.iterator.

Mô tả

Mỗi khi một đối tượng cần được lặp lại (chẳng hạn như ở đầu vòng lặp for...of), phương thức [Symbol.iterator]() của nó được gọi mà không có đối số, và iterator được trả về sẽ được dùng để thu thập các giá trị cần lặp.

Một số kiểu tích hợp sẵn có hành vi lặp lại mặc định, trong khi các kiểu khác (như Object) thì không. Một số kiểu tích hợp sẵn có phương thức [Symbol.iterator]():

• Array.prototype[Symbol.iterator]()
• TypedArray.prototype[Symbol.iterator]()
• String.prototype[Symbol.iterator]()
• Map.prototype[Symbol.iterator]()
• Set.prototype[Symbol.iterator]()

Xem thêm Giao thức lặp lại để biết thêm thông tin.

Ví dụ

Iterable do người dùng định nghĩa

Chúng ta có thể tạo iterable của riêng mình như sau:

const myIterable = {};
myIterable[Symbol.iterator] = function* () {
  yield 1;
  yield 2;
  yield 3;
};
[...myIterable]; // [1, 2, 3]

Hoặc iterable có thể được định nghĩa trực tiếp bên trong một class hoặc đối tượng bằng computed property:

class Foo {
  *[Symbol.iterator]() {
    yield 1;
    yield 2;
    yield 3;
  }
}

const someObj = {
  *[Symbol.iterator]() {
    yield "a";
    yield "b";
  },
};

console.log(...new Foo()); // 1, 2, 3
console.log(...someObj); // 'a', 'b'

Iterable không đúng định dạng

Nếu phương thức [Symbol.iterator]() của iterable không trả về một đối tượng iterator, thì đây là iterable không đúng định dạng. Sử dụng nó như vậy có thể dẫn đến ngoại lệ runtime hoặc hành vi lỗi:

const nonWellFormedIterable = {};
nonWellFormedIterable[Symbol.iterator] = () => 1;
[...nonWellFormedIterable]; // TypeError: [Symbol.iterator]() returned a non-object value

Đặc tả

Tương thích trình duyệt

Xem thêm

• Polyfill của Symbol.iterator trong core-js
• Giao thức lặp lại
• Array.prototype[Symbol.iterator]()
• TypedArray.prototype[Symbol.iterator]()
• String.prototype[Symbol.iterator]()
• Map.prototype[Symbol.iterator]()
• Set.prototype[Symbol.iterator]()
• arguments[Symbol.iterator]()
• Segments.prototype[Symbol.iterator]()