Offers class

  • Reference
Package:
@azure/cosmos

Use to query or read all Offers.

See readOffer(RequestOptions) to read or replace an existing readOffer(RequestOptions) by id.

Properties

client

Methods

query(SqlQuerySpec, FeedOptions)

Query all offers.
query<T>(SqlQuerySpec, FeedOptions)

Query all offers.
readAll(FeedOptions)

Read all offers.

Example

Read all offers to array.

const {body: offerList} = await client.offers.readAll().fetchAll();

Property Details

client 

client: CosmosClient

Property Value

CosmosClient

Method Details

query(SqlQuerySpec, FeedOptions)

Query all offers.

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

Parameters

query
SqlQuerySpec

Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.

options
FeedOptions

Returns

QueryIterator<any>

query<T>(SqlQuerySpec, FeedOptions)

Query all offers.

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

Parameters

query
SqlQuerySpec

Query configuration for the operation. See SqlQuerySpec for more info on how to configure a query.

options
FeedOptions

Returns

QueryIterator<T>

readAll(FeedOptions)

Read all offers.

Example

Read all offers to array.

const {body: offerList} = await client.offers.readAll().fetchAll();

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

Parameters

options
FeedOptions

Returns

QueryIterator<OfferDefinition & Resource>