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:130
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:140
toArray
▸ toArray(): Offer[]
Returns the elements in an array.
Returns
Offer[]
Defined in
@mangrovedao/mangrove.js/src/semibook.ts:143
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
▸ Optional 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
▸ Optional 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@92
Defined in
typescript/lib/lib.es2015.iterable.d.ts:55