Class: Cheque
Defined in: bee-js/src/modules/cheque.ts:18
Cheque operations (last cheques and cashouts).
Accessed as bee.cheque.
Constructors
Constructor
new Cheque(
context):Cheque
Defined in: bee-js/src/modules/cheque.ts:19
Parameters
context
BeeContext
Returns
Cheque
Methods
cashoutLast()
cashoutLast(
address,options?,requestOptions?):Promise<TransactionId>
Defined in: bee-js/src/modules/cheque.ts:67
Cashes out the last cheque for a specific peer.
Parameters
address
Swarm address of peer
string | PeerAddress
options?
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<TransactionId>
getAllLatest()
getAllLatest(
requestOptions?):Promise<LastChequesResponse>
Defined in: bee-js/src/modules/cheque.ts:26
Gets the last cheques for all peers.
Parameters
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<LastChequesResponse>
getAllLatestForPeer()
getAllLatestForPeer(
address,requestOptions?):Promise<LastChequesForPeerResponse>
Defined in: bee-js/src/modules/cheque.ts:36
Gets the last cheques for a specific peer.
Parameters
address
Overlay address of peer.
string | PeerAddress
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<LastChequesForPeerResponse>
getLastCashoutAction()
getLastCashoutAction(
address,requestOptions?):Promise<LastCashoutActionResponse>
Defined in: bee-js/src/modules/cheque.ts:51
Gets the last cashout action for a specific peer.
Parameters
address
Overlay address of peer.
string | PeerAddress
requestOptions?
Options for making requests, such as timeouts, custom HTTP agents, headers, etc.
Returns
Promise<LastCashoutActionResponse>