Skip to content
Snippets Groups Projects
Unverified Commit 45094daf authored by DJ Mountney's avatar DJ Mountney Committed by GitHub
Browse files

Typescript: pass 2 at updating api-handlers to match server handlers (#2334)

* Typescript: pass 2 at updating api-handlers to match server handlers
parent 2bb7b3c2
No related branches found
No related tags found
No related merge requests found
import { type batchUpdateTransactions } from '../server/accounts/transactions';
import { type ServerHandlers } from './server-handlers'; import { type ServerHandlers } from './server-handlers';
export interface ApiHandlers { export interface ApiHandlers {
...@@ -9,20 +11,23 @@ export interface ApiHandlers { ...@@ -9,20 +11,23 @@ export interface ApiHandlers {
...args: Parameters<ServerHandlers['load-budget']> ...args: Parameters<ServerHandlers['load-budget']>
) => Promise<void>; ) => Promise<void>;
'api/download-budget': (arg: { syncId; password }) => Promise<unknown>; 'api/download-budget': (arg: {
syncId: string;
password?: string;
}) => Promise<void>;
'api/start-import': (arg: { budgetName }) => Promise<unknown>; 'api/start-import': (arg: { budgetName: string }) => Promise<void>;
'api/finish-import': () => Promise<unknown>; 'api/finish-import': () => Promise<void>;
'api/abort-import': () => Promise<unknown>; 'api/abort-import': () => Promise<void>;
'api/query': (arg: { query }) => Promise<unknown>; 'api/query': (arg: { query }) => Promise<unknown>;
'api/budget-months': () => Promise<unknown>; 'api/budget-months': () => Promise<string[]>;
'api/budget-month': (arg: { month }) => Promise<{ 'api/budget-month': (arg: { month }) => Promise<{
month; month: string;
incomeAvailable: number; incomeAvailable: number;
lastMonthOverspent: number; lastMonthOverspent: number;
forNextMonth: number; forNextMonth: number;
...@@ -37,16 +42,16 @@ export interface ApiHandlers { ...@@ -37,16 +42,16 @@ export interface ApiHandlers {
}>; }>;
'api/budget-set-amount': (arg: { 'api/budget-set-amount': (arg: {
month; month: string;
categoryId; categoryId: string;
amount; amount: number;
}) => Promise<unknown>; }) => Promise<void>;
'api/budget-set-carryover': (arg: { 'api/budget-set-carryover': (arg: {
month; month: string;
categoryId; categoryId: string;
flag; flag: boolean;
}) => Promise<unknown>; }) => Promise<void>;
'api/transactions-export': (arg: { 'api/transactions-export': (arg: {
transactions; transactions;
...@@ -68,22 +73,27 @@ export interface ApiHandlers { ...@@ -68,22 +73,27 @@ export interface ApiHandlers {
}) => Promise<'ok'>; }) => Promise<'ok'>;
'api/transactions-get': (arg: { 'api/transactions-get': (arg: {
accountId; accountId?: string;
startDate; startDate?: string;
endDate; endDate?: string;
}) => Promise<unknown>; }) => Promise<TransactionEntity[]>;
'api/transaction-update': (arg: { id; fields }) => Promise<unknown>; 'api/transaction-update': (arg: {
id;
fields;
}) => Promise<Awaited<ReturnType<typeof batchUpdateTransactions>>['updated']>;
'api/transaction-delete': (arg: { id }) => Promise<unknown>; 'api/transaction-delete': (arg: {
id;
}) => Promise<Awaited<ReturnType<typeof batchUpdateTransactions>>['updated']>;
'api/sync': () => Promise<unknown>; 'api/sync': () => Promise<void>;
'api/accounts-get': () => Promise<AccountEntity[]>; 'api/accounts-get': () => Promise<AccountEntity[]>;
'api/account-create': (arg: { account; initialBalance? }) => Promise<string>; 'api/account-create': (arg: { account; initialBalance? }) => Promise<string>;
'api/account-update': (arg: { id; fields }) => Promise<unknown>; 'api/account-update': (arg: { id; fields }) => Promise<void>;
'api/account-close': (arg: { 'api/account-close': (arg: {
id; id;
...@@ -112,7 +122,10 @@ export interface ApiHandlers { ...@@ -112,7 +122,10 @@ export interface ApiHandlers {
'api/category-update': (arg: { id; fields }) => Promise<unknown>; 'api/category-update': (arg: { id; fields }) => Promise<unknown>;
'api/category-delete': (arg: { id; transferCategoryId }) => Promise<unknown>; 'api/category-delete': (arg: {
id;
transferCategoryId?;
}) => Promise<{ error?: string }>;
'api/payees-get': () => Promise<PayeeEntity[]>; 'api/payees-get': () => Promise<PayeeEntity[]>;
......
---
category: Maintenance
authors: [twk3]
---
Define more of the returns types in api-handlers.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment