Changes
Page history
Update generated documentation
authored
Jan 29, 2025
by
Mateusz Tyszczak
Hide whitespace changes
Inline
Side-by-side
classes/WorkerBeeIterable.md
0 → 100644
View page @
00aa6d47
[
@hiveio/workerbee v1.27.6-rc9-stable.250129105732
](
../globals
)
/ WorkerBeeIterable
# Class: WorkerBeeIterable\<T\>
Container that can be iterated over the elements of the collection.
## Examples
```
typescript
for
(
const
{
transaction
}
of
data
.
whaleOperations
)
console
.
log
(
`Got transaction: #
${
transaction
.
id
}
`
);
```
```
typescript
data
.
whaleOperations
.
forEach
(({
transaction
})
=>
console
.
log
(
`Got transaction: #
${
transaction
.
id
}
`
)));
```
## Type Parameters
•
**T**
## Implements
-
`Iterable`
\<
`T`
\>
## Constructors
### new WorkerBeeIterable()
> **new WorkerBeeIterable**\<`T`\>(`iterable`): [`WorkerBeeIterable`](./WorkerBeeIterable)\<`T`\>
#### Parameters
•
**iterable**
:
`Iterable`
\<
`T`
,
`any`
,
`any`
\>
#### Returns
[
`WorkerBeeIterable`
](
./WorkerBeeIterable
)
\<
`T`
\>
#### Defined in
[
src/types/iterator.ts:16
](
https://gitlab.syncad.com/hive/workerbee/-/blob/c86a48da91e9edabfae917e1bf4069da65412f97/src/types/iterator.ts#L16
)
## Methods
### \[iterator\]()
> **\[iterator\]**(): `Iterator`\<`T`, `any`, `any`\>
#### Returns
`Iterator`
\<
`T`
,
`any`
,
`any`
\>
#### Implementation of
`Iterable.[iterator]`
#### Defined in
[
src/types/iterator.ts:18
](
https://gitlab.syncad.com/hive/workerbee/-/blob/c86a48da91e9edabfae917e1bf4069da65412f97/src/types/iterator.ts#L18
)
***
### forEach()
> **forEach**(`callbackfn`): `void`
#### Parameters
•
**callbackfn**
#### Returns
`void`
#### Defined in
[
src/types/iterator.ts:26
](
https://gitlab.syncad.com/hive/workerbee/-/blob/c86a48da91e9edabfae917e1bf4069da65412f97/src/types/iterator.ts#L26
)
***
### values()
> **values**(): `Iterable`\<`T`, `any`, `any`\>
#### Returns
`Iterable`
\<
`T`
,
`any`
,
`any`
\>
#### Defined in
[
src/types/iterator.ts:22
](
https://gitlab.syncad.com/hive/workerbee/-/blob/c86a48da91e9edabfae917e1bf4069da65412f97/src/types/iterator.ts#L22
)