Skip to main content

Interface: SitesApiInterface

Defined in: electron/preload/domains/sitesApi.ts:24

Interface defining the sites domain API operations.

Extends​

Properties​

addSite()​

addSite: (...args: [Site]) => Promise<Site>

Defined in: electron/preload/domains/sitesApi.ts:32

Adds a new site to be monitored

Parameters​

args​

...[Site]

Returns​

Promise<Site>

Promise resolving to the created site

Overrides​

SitesChannelMap.addSite

deleteAllSites()​

deleteAllSites: () => Promise<number>

Defined in: electron/preload/domains/sitesApi.ts:39

Deletes all sites (dangerous operation)

Returns​

Promise<number>

Promise resolving to the number of removed sites

Overrides​

SitesChannelMap.deleteAllSites

getSites()​

getSites: () => Promise<Site[]>

Defined in: electron/preload/domains/sitesApi.ts:46

Retrieves all sites from the database

Returns​

Promise<Site[]>

Promise resolving to array of all sites

Overrides​

SitesChannelMap.getSites

removeMonitor()​

removeMonitor: (...args: [string, string]) => Promise<Site>

Defined in: electron/preload/domains/sitesApi.ts:57

Removes a monitor from a site

Parameters​

args​

...[string, string]

Returns​

Promise<Site>

Promise resolving to the updated site snapshot emitted by the backend after removal

Overrides​

SitesChannelMap.removeMonitor

removeSite()​

removeSite: (...args: [string]) => Promise<boolean>

Defined in: electron/preload/domains/sitesApi.ts:66

Removes a site from monitoring

Parameters​

args​

...[string]

Returns​

Promise<boolean>

Promise resolving to a boolean indicating removal success

Overrides​

SitesChannelMap.removeSite

updateSite()​

updateSite: (...args: [string, Partial<Site>]) => Promise<Site>

Defined in: electron/preload/domains/sitesApi.ts:76

Updates an existing site's configuration

Parameters​

args​

...[string, Partial<Site>]

Returns​

Promise<Site>

Promise resolving to the updated site

Overrides​

SitesChannelMap.updateSite