Class Offers

Use to query or read all Offers.

see: Offer to read or replace an existing Offer by id.

Hierarchy

Offers

Index

Properties

client

Methods

Properties

client

client: CosmosClient

The parent CosmosClient for the offers.

Methods

query

query(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<any>
query<T>(query: SqlQuerySpec, options?: FeedOptions): QueryIterator<T>

- Defined in client/Offer/Offers.ts:27
Query all offers.

Parameters
- query: SqlQuerySpec
  
  Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.
- Optional options: FeedOptions
Returns QueryIterator<any>
- Defined in client/Offer/Offers.ts:33
Query all offers.

Type parameters
- T
Parameters
- query: SqlQuerySpec
  
  Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.
- Optional options: FeedOptions
Returns QueryIterator<T>

readAll

readAll(options?: FeedOptions): QueryIterator<OfferDefinition & Resource>

- Defined in client/Offer/Offers.ts:55
Read all offers.
example
Read all offers to array.
```
const {body: offerList} = await client.offers.readAll().toArray();
```
Parameters
- Optional options: FeedOptions
Returns QueryIterator<OfferDefinition & Resource>

Generated using TypeDoc