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

Validate cursor for feeds #296

Merged
merged 1 commit into from
Nov 4, 2024
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
12 changes: 12 additions & 0 deletions __tests__/functional/feed-client-configuration.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -97,4 +97,16 @@ describe("FeedClientConfiguration", () => {
expect(e).toBeInstanceOf(RangeError);
}
});

it("throws a TypeError if 'cursor' is not a string", async () => {
const config = { ...defaultConfig, cursor: null };
try {
new FeedClient(
dummyStreamToken,
config as unknown as FeedClientConfiguration,
);
} catch (e: any) {
expect(e).toBeInstanceOf(TypeError);
}
});
});
4 changes: 4 additions & 0 deletions src/client.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1152,6 +1152,10 @@ export class FeedClient<T extends QueryValue = any> {
"Only one of 'start_ts' or 'cursor' can be defined in the client configuration.",
);
}

if (config.cursor !== undefined && typeof config.cursor !== "string") {
throw new TypeError("'cursor' must be a string.");
}
}
}

Expand Down
Loading