shared/ipc/bookmarks-contracts

Type Aliases

BookmarkItem

BookmarkItem = v.InferOutput<typeof BookmarkItem>

Defined in: app/src/shared/ipc/bookmarks-contracts.ts:12

A bookmark or a folder as the bookmarks page shows it.

Variables

AddBookmark

const AddBookmark: RequestContract<{ parentId: number; title: string; url?: string; }, { id: number; }>

Defined in: app/src/shared/ipc/bookmarks-contracts.ts:31

Adds a bookmark, or a folder when there is no address, at the end of a folder.

---

BookmarkItem

const BookmarkItem: StrictObjectSchema<{ id: SchemaWithPipe<readonly [NumberSchema<undefined>, IntegerAction<number, undefined>, MinValueAction<number, 1, undefined>]>; parentId: NullableSchema<SchemaWithPipe<readonly [NumberSchema<undefined>, IntegerAction<number, undefined>, MinValueAction<number, 1, undefined>]>, undefined>; title: StringSchema<undefined>; url: NullableSchema<StringSchema<undefined>, undefined>; }, undefined>

Defined in: app/src/shared/ipc/bookmarks-contracts.ts:12

A bookmark or a folder as the bookmarks page shows it. The two root folders, the bookmarks bar and the other bookmarks, have no parent; folders have no address.

---

BookmarksChanged

const BookmarksChanged: EventContract<null>

Defined in: app/src/shared/ipc/bookmarks-contracts.ts:68

Sent to open bookmarks pages when the bookmarks changed elsewhere, such as by the star.

---

ListBookmarks

const ListBookmarks: RequestContract<{ }, { items: object[]; }>

Defined in: app/src/shared/ipc/bookmarks-contracts.ts:23

Lists every bookmark and folder in display order.

---

OpenBookmark

const OpenBookmark: RequestContract<{ newTab: boolean; url: string; }, null>

Defined in: app/src/shared/ipc/bookmarks-contracts.ts:60

Opens a bookmark in the bookmarks page’s tab or in a new tab.

---

RemoveBookmark

const RemoveBookmark: RequestContract<{ id: number; }, null>

Defined in: app/src/shared/ipc/bookmarks-contracts.ts:52

Removes a bookmark, or a folder with everything in it.

---

UpdateBookmark

const UpdateBookmark: RequestContract<{ id: number; parentId?: number; title: string; url?: string; }, null>

Defined in: app/src/shared/ipc/bookmarks-contracts.ts:39

Renames a bookmark or folder, changes a bookmark’s address, or moves either to a folder.