@lou.codes/predicates/dist/hasIteratorSymbol.d.ts

🧐 Predicate util functions

/**
 * Check if given object has the `Symbol.iterator` symbol.
 *
 * @category Iterables
 * @category Objects
 * @example
 * ```typescript
 * hasIteratorSymbol({ [Symbol.iterator]() {} }); // true
 * hasIteratorSymbol({ bar: "bar" }); // false
 * ```
 * @returns `true` when given object has the `Symbol.iterator` symbol, `false`
 * otherwise.
 */
export declare const hasIteratorSymbol: (
	object: unknown,
) => object is Readonly<Record<typeof Symbol.iterator, unknown>>;