Skip to content

jstnm-doc-fix : doc fix #370

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

Open
sastaachar wants to merge 1 commit into
base: main
Choose a base branch
from
Open

jstnm-doc-fix : doc fix #370

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
4 changes: 1 addition & 3 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2743,7 +2743,7 @@ export enum EmbedEvent {
*
* This event can be emitted to intercept search execution initiated by
* the users and implement the logic to allow or restrict search execution.
* You can can also show custom error text if the search query must be
* You can also show custom error text if the search query must be
* restricted due to your application or business requirements.

* Prerequisite: Set `isOnBeforeGetVizDataInterceptEnabled` to `true`
Expand Down Expand Up @@ -6208,7 +6208,6 @@ export type ApiInterceptFlags = {
* ```js
* const embed = new LiveboardEmbed('#embed', {
* ...viewConfig,
* enableApiIntercept: true,
* interceptUrls: [InterceptedApiType.DATA],
Comment on lines 6211 to 6212
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Dec 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Removing the deprecated enableApiIntercept flag is correct. However, the example still uses InterceptedApiType.DATA, which appears to be an invalid value for URL interception. It will be treated as a literal string 'DATA', which is likely not the intended behavior. The suggestion below removes the deprecated flag and replaces DATA with LiveboardData to make the example correct.

Suggested change
* interceptUrls: [InterceptedApiType.DATA],
* interceptUrls: [InterceptedApiType.LiveboardData],

* })
* ```
Expand All @@ -6224,7 +6223,6 @@ export type ApiInterceptFlags = {
* ```js
* const embed = new LiveboardEmbed('#embed', {
* ...viewConfig,
* enableApiIntercept: true,
* interceptUrls: [InterceptedApiType.ALL],
* interceptTimeout: 1000,
* })
Expand Down
Loading