@webflow/designer-extension-typings 2.0.6 → 2.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/pages.d.ts +16 -16
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@webflow/designer-extension-typings",
3
- "version": "2.0.6",
3
+ "version": "2.0.7",
4
4
  "license": "SEE LICENSE IN LICENSE",
5
5
  "description": "Typings for the Webflow Designer Extension API",
6
6
  "main": "",
package/pages.d.ts CHANGED
@@ -130,13 +130,13 @@ interface Page {
130
130
  getTitle(): Promise<string>;
131
131
  /**
132
132
  * Sets the title of the page to the provided value.
133
- * @param title - The new title to set for the page.
133
+ * @param title - The new title to set for the page. Passing null will unset the current value.
134
134
  * @example
135
135
  * ```ts
136
136
  * await myPage.setTitle("New Page Title");
137
137
  * ```
138
138
  */
139
- setTitle(title: string): Promise<null>;
139
+ setTitle(title: string | null): Promise<null>;
140
140
  /**
141
141
  * Retrieves the description of the page.
142
142
  * @example
@@ -148,13 +148,13 @@ interface Page {
148
148
  getDescription(): Promise<string>;
149
149
  /**
150
150
  * Sets the description of the page to the provided value.
151
- * @param description - The new description to set for the page.
151
+ * @param description - The new description to set for the page. Passing null will unset the current value.
152
152
  * @example
153
153
  * ```ts
154
154
  * await myPage.setDescription("New Page Description");
155
155
  * ```
156
156
  */
157
- setDescription(description: string): Promise<null>;
157
+ setDescription(description: string | null): Promise<null>;
158
158
  /**
159
159
  * Checks if the page is in draft mode or not.
160
160
  * @example
@@ -203,13 +203,13 @@ interface Page {
203
203
  getOpenGraphTitle(): Promise<string>;
204
204
  /**
205
205
  * Sets the Open Graph (OG) title of the page to the provided value.
206
- * @param title - The new OG title to set for the page.
206
+ * @param title - The new OG title to set for the page. Passing null will unset the current value.
207
207
  * @example
208
208
  * ```ts
209
209
  * await myPage.setOpenGraphTitle("New OG Title");
210
210
  * ```
211
211
  */
212
- setOpenGraphTitle(title: string): Promise<null>;
212
+ setOpenGraphTitle(title: string | null): Promise<null>;
213
213
  /**
214
214
  * Checks if the page uses its description as the Open Graph description.
215
215
  * @example
@@ -239,13 +239,13 @@ interface Page {
239
239
  getOpenGraphDescription(): Promise<string>;
240
240
  /**
241
241
  * Sets the Open Graph (OG) description of the page to the provided value.
242
- * @param description - The new OG description to set for the page.
242
+ * @param description - The new OG description to set for the page. Passing null will unset the current value.
243
243
  * @example
244
244
  * ```ts
245
245
  * myPage.setOpenGraphDescription("New OG Description");
246
246
  * ```
247
247
  */
248
- setOpenGraphDescription(description: string): Promise<null>;
248
+ setOpenGraphDescription(description: string | null): Promise<null>;
249
249
  /**
250
250
  * Retrieves the URL of the Open Graph (OG) image associated with the page.
251
251
  * @example
@@ -257,13 +257,13 @@ interface Page {
257
257
  getOpenGraphImage(): Promise<null | string>;
258
258
  /**
259
259
  * Sets the URL of the Open Graph (OG) image associated with the page.
260
- * @param url - The new URL of the OG image to set for the page.
260
+ * @param url - The new URL of the OG image to set for the page. Passing null will unset the current value.
261
261
  * @example
262
262
  * ```ts
263
263
  * myPage.setOpenGraphImage("https://example.com/image.jpg");
264
264
  * ```
265
265
  */
266
- setOpenGraphImage(url: string): Promise<null>;
266
+ setOpenGraphImage(url: string | null): Promise<null>;
267
267
  /**
268
268
  * Checks if the page is excluded from search engine indexing.
269
269
  * @example
@@ -311,13 +311,13 @@ interface Page {
311
311
  getSearchTitle(): Promise<string>;
312
312
  /**
313
313
  * Sets the search engine title of the page to the provided value.
314
- * @param title - The new search engine title to set for the page.
314
+ * @param title - The new search engine title to set for the page. Passing null will unset the current value.
315
315
  * @example
316
316
  * ```ts
317
317
  * myPage.setSearchTitle("New Search Engine Title");
318
318
  * ```
319
319
  */
320
- setSearchTitle(title: string): Promise<null>;
320
+ setSearchTitle(title: string | null): Promise<null>;
321
321
  /**
322
322
  * Checks if the page uses its description as the search engine description.
323
323
  * @example
@@ -347,13 +347,13 @@ interface Page {
347
347
  getSearchDescription(): Promise<string>;
348
348
  /**
349
349
  * Sets the search engine description of the page to the provided value.
350
- * @param description - The new search engine description to set for the page.
350
+ * @param description - The new search engine description to set for the page. Passing null will unset the current value.
351
351
  * @example
352
352
  * ```ts
353
353
  * myPage.setSearchDescription("New Search Engine Description");
354
354
  * ```
355
355
  */
356
- setSearchDescription(description: string): Promise<null>;
356
+ setSearchDescription(description: string | null): Promise<null>;
357
357
  /**
358
358
  * Checks if the page uses its Open Graph (OG) image as the search engine image.
359
359
  * @example
@@ -382,13 +382,13 @@ interface Page {
382
382
  getSearchImage(): Promise<string>;
383
383
  /**
384
384
  * Sets the search engine image URL of the page.
385
- * @param url - The new search engine image URL to set for the page.
385
+ * @param url - The new search engine image URL to set for the page. Passing null will unset the current value.
386
386
  * @example
387
387
  * ```ts
388
388
  * myPage.setSearchImage("https://example.com/image.jpg");
389
389
  * ```
390
390
  */
391
- setSearchImage(url: string): Promise<null>;
391
+ setSearchImage(url: string | null): Promise<null>;
392
392
  /**
393
393
  * Checks if the page is password-protected.
394
394
  * @example