Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[@azure/cosmos] Deprecate older changeFeed iterator #32651

Merged
merged 1 commit into from
Jan 29, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions sdk/cosmosdb/cosmos/review/cosmos.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -1267,9 +1267,13 @@ export class Items {
constructor(container: Container, clientContext: ClientContext);
batch(operations: OperationInput[], partitionKey?: PartitionKey, options?: RequestOptions): Promise<Response_2<OperationResponse[]>>;
bulk(operations: OperationInput[], bulkOptions?: BulkOptions, options?: RequestOptions): Promise<BulkOperationResponse>;
// @deprecated
amanrao23 marked this conversation as resolved.
Show resolved Hide resolved
changeFeed(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>;
// @deprecated
changeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>;
// @deprecated
changeFeed<T>(partitionKey: PartitionKey, changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>;
// @deprecated
changeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>;
// (undocumented)
readonly container: Container;
Expand Down
13 changes: 8 additions & 5 deletions sdk/cosmosdb/cosmos/src/client/Item/Items.ts
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ export class Items {
/**
* Create a `ChangeFeedIterator` to iterate over pages of changes
*
* @deprecated Use `changeFeed` instead.
* @deprecated Use `getChangeFeedIterator` instead.
*
* @example Read from the beginning of the change feed.
* ```javascript
Expand All @@ -164,21 +164,21 @@ export class Items {
): ChangeFeedIterator<any>;
/**
* Create a `ChangeFeedIterator` to iterate over pages of changes
* @deprecated Use `changeFeed` instead.
* @deprecated Use `getChangeFeedIterator` instead.
*
*/
public readChangeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>;
/**
* Create a `ChangeFeedIterator` to iterate over pages of changes
* @deprecated Use `changeFeed` instead.
* @deprecated Use `getChangeFeedIterator` instead.
*/
public readChangeFeed<T>(
partitionKey: PartitionKey,
changeFeedOptions?: ChangeFeedOptions,
): ChangeFeedIterator<T>;
/**
* Create a `ChangeFeedIterator` to iterate over pages of changes
* @deprecated Use `changeFeed` instead.
* @deprecated Use `getChangeFeedIterator` instead.
*/
public readChangeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>;
public readChangeFeed<T>(
Expand All @@ -194,7 +194,7 @@ export class Items {

/**
* Create a `ChangeFeedIterator` to iterate over pages of changes
*
* @deprecated Use `getChangeFeedIterator` instead.
* @example Read from the beginning of the change feed.
* ```javascript
* const iterator = items.readChangeFeed({ startFromBeginning: true });
Expand All @@ -209,17 +209,20 @@ export class Items {
): ChangeFeedIterator<any>;
/**
* Create a `ChangeFeedIterator` to iterate over pages of changes
* @deprecated Use `getChangeFeedIterator` instead.
*/
public changeFeed(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<any>;
/**
* Create a `ChangeFeedIterator` to iterate over pages of changes
* @deprecated Use `getChangeFeedIterator` instead.
*/
public changeFeed<T>(
partitionKey: PartitionKey,
changeFeedOptions?: ChangeFeedOptions,
): ChangeFeedIterator<T>;
/**
* Create a `ChangeFeedIterator` to iterate over pages of changes
* @deprecated Use `getChangeFeedIterator` instead.
*/
public changeFeed<T>(changeFeedOptions?: ChangeFeedOptions): ChangeFeedIterator<T>;
public changeFeed<T>(
Expand Down
Loading