Class: SwapDataset<D>

Swap Dataset

Type parameters

Name	Type
D	extends Dataset

Hierarchy

• DatasetClass<D, Swap>

  ↳ SwapDataset

Methods

create

▸ create(req): Promise<Transaction>

Create a swap

Parameters

Name	Type	Description
req	Build5Request<SwapCreateRequest>	Use Build5Request with data based on SwapCreateRequest

Returns

Promise<Transaction>

---

getAllUpdatedAfter

▸ getAllUpdatedAfter(updatedAfter, startAfter?): Promise<Swap[]>

Get all records updated after unix timestamp.

Parameters

Name	Type
updatedAfter	number
startAfter?	string

Returns

Promise<Swap[]>

Inherited from

DatasetClass.getAllUpdatedAfter

---

getAllUpdatedAfterLive

▸ getAllUpdatedAfterLive(updatedAfter, startAfter?): Observable<Swap[]>

Get all records updated after unix timestamp. Real time stream.

Parameters

Name	Type
updatedAfter	number
startAfter?	string

Returns

Observable<Swap[]>

Inherited from

DatasetClass.getAllUpdatedAfterLive

---

getByField

▸ getByField(fieldName, fieldValue, startAfter?): Promise<Swap[]>

Get records by field.

Parameters

Name	Type
fieldName	string | string[]
fieldValue	string | number | boolean | (string | number | boolean)[]
startAfter?	string

Returns

Promise<Swap[]>

Inherited from

DatasetClass.getByField

---

getByFieldLive

▸ getByFieldLive(fieldName, fieldValue, startAfter?): Observable<Swap[]>

Get records by field. Real time stream.

Parameters

Name	Type
fieldName	string | string[]
fieldValue	string | number | boolean | (string | number | boolean)[]
startAfter?	string

Returns

Observable<Swap[]>

Inherited from

DatasetClass.getByFieldLive

---

getBySpace

▸ getBySpace(space, startAfter?): Promise<Swap[]>

Get records by space.

Parameters

Name	Type
space	string
startAfter?	string

Returns

Promise<Swap[]>

Inherited from

DatasetClass.getBySpace

---

getBySpaceLive

▸ getBySpaceLive(space, startAfter?): Observable<Swap[]>

Get records by space. Real time stream.

Parameters

Name	Type
space	string
startAfter?	string

Returns

Observable<Swap[]>

Inherited from

DatasetClass.getBySpaceLive

---

getManyById

▸ getManyById(setIds): Promise<Swap[]>

Get many records by id.

Parameters

Name	Type
setIds	string[]

Returns

Promise<Swap[]>

Inherited from

DatasetClass.getManyById

---

getManyByIdLive

▸ getManyByIdLive(setIds): Observable<Swap[]>

Get many records by id. Real time stream.

Parameters

Name	Type
setIds	string[]

Returns

Observable<Swap[]>

Inherited from

DatasetClass.getManyByIdLive

---

id

▸ id(setId): ExactDataSet<D, Swap>

Get specific record by id.

Parameters

Name	Type
setId	string

Returns

ExactDataSet<D, Swap>

Inherited from

DatasetClass.id

---

reject

▸ reject(req): Promise<Transaction>

Reject swap

Parameters

Name	Type	Description
req	Build5Request<SwapRejectRequest>	Use Build5Request with data based on SwapRejectRequest

Returns

Promise<Transaction>

---

setFunded

▸ setFunded(req): Promise<Transaction>

Set swap as funded

Parameters

Name	Type	Description
req	Build5Request<SwapSetFundedRequest>	Use Build5Request with data based on SwapSetFundedRequest

Returns

Promise<Transaction>