@builder.io/sdk-vue/lib/edge/functions/is-previewing.d.ts

Builder.io SDK for Vue

import type { Search } from '../helpers/search/search';
/**
 * Checks the current URL's search parameters to see if it is attempting to
 * preview Builder Content.
 *
 * When called on the client, it uses `window.location.search`.
 * When called on the server (SSR), it requires a `search` argument.
 *
 * @param search - The search parameters to check. Can be a URL string (containing the search parameters), `URLSearchParams`, or a key-value object containing the search parameters.
 * @returns `true` if the current page is being previewed, `false` otherwise.
 */
export declare function isPreviewing(search?: Search): boolean;