Share via

Offers class

Package:
@azure/cosmos

Use to query or read all Offers.

See Offer to read or replace an existing Offer by id.

Properties

client

Methods

query(SqlQuerySpec, FeedOptions)

Query all offers.

Example

Read offer for a specific id.

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @offer`,
  parameters: [{ name: "@offer", value: "<offer-id>" }],
};
const { resources: offer } = await client.offers.query(querySpec).fetchAll();
query<T>(SqlQuerySpec, FeedOptions)

Query all offers.
readAll(FeedOptions)

Read all offers.

Example

Read all offers to array.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

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

Property Details

client 

client: CosmosClient

Property Value

CosmosClient

Method Details

query(SqlQuerySpec, FeedOptions)

Query all offers.

Example

Read offer for a specific id.

import { CosmosClient, SqlQuerySpec } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

const querySpec: SqlQuerySpec = {
  query: `SELECT * FROM root r WHERE r.id = @offer`,
  parameters: [{ name: "@offer", value: "<offer-id>" }],
};
const { resources: offer } = await client.offers.query(querySpec).fetchAll();

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.

import { CosmosClient } from "@azure/cosmos";

const endpoint = "https://your-account.documents.azure.com";
const key = "<database account masterkey>";
const client = new CosmosClient({ endpoint, key });

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

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

Parameters

options
FeedOptions

Returns

QueryIterator<OfferDefinition & Resource>