Interface IActualApiServer

Shape of the Actual API for server mode with download.

interface IActualApiServer {
    init: (opts: Record<string, string>) => Promise<object>;
    loadBudget: (id: string) => ApiSideEffect;
    downloadBudget: (id: string, opts?: { password?: string }) => ApiSideEffect;
}

Hierarchy (View Summary)

IActualApiLocal
- IActualApiServer

Index

Properties

init loadBudget downloadBudget

Properties

`Readonly`init

init: (opts: Record<string, string>) => Promise<object>

`Readonly`loadBudget

loadBudget: (id: string) => ApiSideEffect

`Readonly`downloadBudget

downloadBudget: (id: string, opts?: { password?: string }) => ApiSideEffect