TypeTags .ArrayIterator

Overview

The @@iterator method is part of The Iterable Protocol, that defines how to synchronously iterate over a sequence of values.

The initial value of the @@iterator property is the same function object as the initial value of the values() property.

Usage

import { TypeTags } from 'typetags'
console.log(TypeTags.ArrayIterator)
// → [object Array Iterator]

Predicate

.isArrayIterator(value)

  • Checks if value is or has a default Array Iterator type tag.
const { TypeTags } = require('typetags')
let iterator = [][Symbol.iterator]()
TypeTags.isArrayIterator(iterator)
// → true
let tag = TypeTags.get(iterator)
TypeTags.isArrayIterator(tag)
// → true

Metadata (TType)

MetadataValue
.typeArray.Iterator
.tag[object Array Iterator]
.builtin()undefined
.getTag()[object Array Iterator]
.hasSpecialArgs()false
.instance()undefined
.instanceTypeOf()object
.info()see more
.isAvailable()true
.isConstructor()false
.isFactory()false
.isFunction()false
.isGlobal()false
.isIterator()true
.isNested()false
.isObject()true
.isPrimitive()false
.isStringifiable()true
.isSyntatic()false
.isTypedArray()false
.ownKeys()[]
.toString()function toString() { [native code] }
.typeOf()object

Signature

declare type ITypeTags = {
[key in Types | NestedTypes]: Tags
}
declare interface Predicate {
predicate(value: any): boolean
}

See MDN Web Docs