Skip to content

Commit 252ca2b

Browse files
docs: fix @default annotations to include valid JS syntax
1 parent 2cecb25 commit 252ca2b

File tree

8 files changed

+12
-12
lines changed

8 files changed

+12
-12
lines changed

browser/dom/cursor.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import type { Page } from "./page.d.ts";
99
export interface SetPositionOptions {
1010
/** Whether to auto-scroll the page when the cursor moves outside the viewport
1111
*
12-
* @default true
12+
* @default {true}
1313
* @type {boolean}
1414
*/
1515
scrollInView?: boolean;

browser/dom/open.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export interface OpenOptions {
1717
* - `true`: open in a new tab
1818
* - `false`: open in the same tab
1919
*
20-
* @default false
20+
* @default {false}
2121
*/
2222
newTab?: boolean;
2323

browser/dom/page.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ export interface SetPositionOptions {
55
/** Whether to auto-scroll the page when the cursor moves outside the viewport
66
* When `true`, the page will automatically scroll to keep the cursor visible
77
*
8-
* @default true
8+
* @default {true}
99
*/
1010
scrollInView?: boolean;
1111

browser/websocket/pin.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ export interface PinOptions extends PushOptions {
1111
* This is useful when you want to create and pin placeholder pages
1212
* that will be filled with content later.
1313
*
14-
* @default false
14+
* @default {false}
1515
*/
1616
create?: boolean;
1717
}

browser/websocket/updateCodeBlock.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export interface UpdateCodeBlockOptions extends PushOptions {
2121
* - New code content
2222
* - Generated change commits
2323
*
24-
* @default false
24+
* @default {false}
2525
*/
2626
debug?: boolean;
2727
}

browser/websocket/updateCodeFile.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ export interface UpdateCodeFileOptions extends PushOptions {
4949
* This option is particularly useful when you want to ensure code blocks
5050
* are created in a consistent location across multiple pages.
5151
*
52-
* @default notInsert
52+
* @default {"notInsert"}
5353
*/
5454
insertPositionIfNotExist?: "top" | "bottom" | "notInsert";
5555

@@ -61,7 +61,7 @@ export interface UpdateCodeFileOptions extends PushOptions {
6161
* - Making it easier to add new content after the code block
6262
* - Maintaining consistent spacing across all pages
6363
*
64-
* @default true
64+
* @default {true}
6565
*/
6666
isInsertEmptyLineInTail?: boolean;
6767

rest/options.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export interface BaseOptions {
2020
* Allows overriding the default fetch behavior for testing
2121
* or custom networking requirements.
2222
*
23-
* @default globalThis.fetch
23+
* @default {globalThis.fetch}
2424
*/
2525
fetch?: RobustFetch;
2626

@@ -30,7 +30,7 @@ export interface BaseOptions {
3030
* with self-hosted Scrapbox instances or other custom deployments that
3131
* don't use the default scrapbox.io domain.
3232
*
33-
* @default scrapbox.io
33+
* @default {"scrapbox.io"}
3434
*/
3535
hostName?: string;
3636
}

rest/pages.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ export const getPage: GetPage = /* @__PURE__ */ (() => {
150150
export interface ListPagesOption extends BaseOptions {
151151
/** the sort of page list to return
152152
*
153-
* @default updated
153+
* @default {"updated"}
154154
*/
155155
sort?:
156156
| "updatedWithMe"
@@ -163,12 +163,12 @@ export interface ListPagesOption extends BaseOptions {
163163
| "title";
164164
/** the index getting page list from
165165
*
166-
* @default 0
166+
* @default {0}
167167
*/
168168
skip?: number;
169169
/** threshold of the length of page list
170170
*
171-
* @default 100
171+
* @default {100}
172172
*/
173173
limit?: number;
174174
}

0 commit comments

Comments
 (0)