@builder.io/sdk-solid 4.2.2 → 4.2.4

package/dist/index.d.ts

@@ -803,7 +803,17 @@ type Search = URLSearchParams | string | QueryObject;
 
 declare function isEditing(search?: Search): boolean;
 
-declare function isPreviewing(_search?: Search): boolean;
+/**
+ * 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.
+ */
+declare function isPreviewing(search?: Search): boolean;
 
 declare const createRegisterComponentMessage: (info: ComponentInfo) => {
     type: string;
@@ -852,8 +862,14 @@ type Settings = {
 declare function setEditorSettings(newSettings: Settings): void;
 
 /**
- * Receives a `URLSearchParams` object or a regular query object, and returns the subset of query params that are
- * relevant to the Builder SDK.
+ * Receives a `URLSearchParams` object or a regular query object, and returns
+ * the subset of query params that are relevant to the Builder SDK.
+ *
+ * Outputs a key-value object to be passed to `fetchOneEntry` or `fetchEntries`
+ * functions as the `options` argument.
+ *
+ * NOTE: This function is generally not needed. Instead, it is recommended to use `isPreviewing()`
+ * to check if the current page requires previewed content.
  *
  * @returns
  */