Skip to content

feat: support stream rule pagination #621

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.

Sign up for GitHub

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

Merged
plhery merged 1 commit into from
Sep 6, 2025
Merged

feat: support stream rule pagination #621

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 12 additions & 1 deletion doc/streaming.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,10 +178,21 @@ Level: **Read-only**.

Returns: **`StreamingV2GetRulesResult`**.

You can limit the number of rules returned per page with `max_results` (min 1, max 1000, default 1000) and paginate using `pagination_token`.

```ts
const client = ...; // (create a Bearer OAuth2 client)

const rules = await client.v2.streamRules();
// Retrieve up to 500 rules per page
const rules = await client.v2.streamRules({ max_results: 500 });

// Fetch next page if a next_token is present
if (rules.meta.next_token) {
const nextPage = await client.v2.streamRules({
pagination_token: rules.meta.next_token,
max_results: 500,
});
}

// Log every rule ID
console.log(rules.data.map(rule => rule.id));
Expand Down
10 changes: 7 additions & 3 deletions src/types/v2/streaming.v2.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,15 @@

// -- Get stream rules --

import { DataAndMetaV2, MetaV2, SentMeta } from './shared.v2.types';
import { DataAndMetaV2, MetaV2, PaginableCountMetaV2, SentMeta } from './shared.v2.types';

export interface StreamingV2GetRulesParams {
/** Comma-separated list of rule IDs. If omitted, all rules are returned. */
ids: string;
ids?: string;
/** Maximum number of rules to return. Min 1, max 1000, default 1000. */
max_results?: number;
/** Token to retrieve the next page of results. */
pagination_token?: string;
}

export interface StreamingV2Rule {
Expand All @@ -20,7 +24,7 @@ export interface StreamingV2Rule {
tag?: string;
}

export type StreamingV2GetRulesResult = DataAndMetaV2<StreamingV2Rule[], SentMeta>;
export type StreamingV2GetRulesResult = DataAndMetaV2<StreamingV2Rule[], PaginableCountMetaV2>;

// -- Add / delete stream rules --

Expand Down