Class: AuctionDataset<D>

Auction dataset to read and trigger POST actions against the API

Type parameters

Name	Type
D	extends Dataset

Hierarchy

• DatasetClass<D, Auction>

  ↳ AuctionDataset

Methods

bid

▸ bid(req): Promise<Transaction>

Bid on auction.

Parameters

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

Returns

Promise<Transaction>

---

create

▸ create(req): Promise<Auction>

Create generic Auction.

Parameters

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

Returns

Promise<Auction>

---

getAllUpdatedAfter

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

Get all records updated after unix timestamp.

Parameters

Name	Type
updatedAfter	number
startAfter?	string

Returns

Promise<Auction[]>

Inherited from

DatasetClass.getAllUpdatedAfter

---

getAllUpdatedAfterLive

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

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

Parameters

Name	Type
updatedAfter	number
startAfter?	string

Returns

Observable<Auction[]>

Inherited from

DatasetClass.getAllUpdatedAfterLive

---

getByField

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

Get records by field.

Parameters

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

Returns

Promise<Auction[]>

Inherited from

DatasetClass.getByField

---

getByFieldLive

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

Get records by field. Real time stream.

Parameters

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

Returns

Observable<Auction[]>

Inherited from

DatasetClass.getByFieldLive

---

getBySpace

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

Get records by space.

Parameters

Name	Type
space	string
startAfter?	string

Returns

Promise<Auction[]>

Inherited from

DatasetClass.getBySpace

---

getBySpaceLive

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

Get records by space. Real time stream.

Parameters

Name	Type
space	string
startAfter?	string

Returns

Observable<Auction[]>

Inherited from

DatasetClass.getBySpaceLive

---

getManyById

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

Get many records by id.

Parameters

Name	Type
setIds	string[]

Returns

Promise<Auction[]>

Inherited from

DatasetClass.getManyById

---

getManyByIdLive

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

Get many records by id. Real time stream.

Parameters

Name	Type
setIds	string[]

Returns

Observable<Auction[]>

Inherited from

DatasetClass.getManyByIdLive

---

id

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

Get specific record by id.

Parameters

Name	Type
setId	string

Returns

ExactDataSet<D, Auction>

Inherited from

DatasetClass.id