Interface: CacheIterator
Semibook.CacheIterator
An iterator over a semibook cache.
Hierarchyβ
IterableIterator
<Offer
>β³
CacheIterator
Methodsβ
filterβ
βΈ filter(predicate
): CacheIterator
Filter the offers in the cache using a predicate.
Parametersβ
Name | Type | Description |
---|---|---|
predicate | (offer : Offer ) => boolean | Function is a predicate, to test each element of the array. Should return true if the element should be kept; otherwise false should be returned. |
Returnsβ
Defined inβ
@mangrovedao/mangrove.js/src/semibook.ts:138
findβ
βΈ find(predicate
): undefined
| Offer
Returns the value of the first element in the provided array that
satisfies the provided predicate. If no values satisfy the testing function,
undefined
is returned.
Parametersβ
Name | Type | Description |
---|---|---|
predicate | (offer : Offer ) => boolean | Function is a predicate, to test each element of the array. The firs offer that satisfies the predicate is returned; otherwise undefined is returned. |
Returnsβ
undefined
| Offer
Defined inβ
@mangrovedao/mangrove.js/src/semibook.ts:148
toArrayβ
βΈ toArray(): Offer
[]
Returns the elements in an array.
Returnsβ
Offer
[]
Defined inβ
@mangrovedao/mangrove.js/src/semibook.ts:151
nextβ
βΈ next(...args
): IteratorResult
<Offer
, any
>
Parametersβ
Name | Type |
---|---|
...args | [] | [undefined ] |
Returnsβ
IteratorResult
<Offer
, any
>
Inherited fromβ
IterableIterator.next
Defined inβ
typescript/lib/lib.es2015.iterable.d.ts:45
returnβ
βΈ return(value?
): IteratorResult
<Offer
, any
>
Parametersβ
Name | Type |
---|---|
value? | any |
Returnsβ
IteratorResult
<Offer
, any
>
Inherited fromβ
IterableIterator.return
Defined inβ
typescript/lib/lib.es2015.iterable.d.ts:46
throwβ
βΈ throw(e?
): IteratorResult
<Offer
, any
>
Parametersβ
Name | Type |
---|---|
e? | any |
Returnsβ
IteratorResult
<Offer
, any
>
Inherited fromβ
IterableIterator.throw
Defined inβ
typescript/lib/lib.es2015.iterable.d.ts:47
[iterator]β
βΈ [iterator](): IterableIterator
<Offer
>
Returnsβ
IterableIterator
<Offer
>
Inherited fromβ
IterableIterator.[iterator]
Defined inβ
typescript/lib/lib.es2015.iterable.d.ts:55