expo-finance-kit
Version:
Native Expo module for Apple FinanceKit - Access financial data from Apple Card and other accounts
98 lines • 2.91 kB
TypeScript
/**
* React hooks for Expo Finance Kit
* Provides easy integration with React components
*/
import { Account, Transaction, AccountBalance, AuthorizationStatus, TransactionQueryOptions, AccountQueryOptions } from '../ExpoFinanceKit.types';
import { TransactionsChangedPayload } from '../ExpoFinanceKit.types';
/**
* Hook for managing authorization status
*/
export declare function useAuthorizationStatus(): {
status: AuthorizationStatus;
loading: boolean;
error: Error | null;
requestAuthorization: () => Promise<import("..").AuthorizationResult>;
isAuthorized: boolean;
};
/**
* Hook for fetching accounts
*/
export declare function useAccounts(options?: AccountQueryOptions): {
accounts: Account[];
loading: boolean;
error: Error | null;
refetch: () => Promise<void>;
};
/**
* Hook for fetching a single account
*/
export declare function useAccount(accountId: string): {
account: Account | null;
loading: boolean;
error: Error | null;
};
/**
* Hook for fetching transactions
*/
export declare function useTransactions(options?: TransactionQueryOptions): {
transactions: Transaction[];
loading: boolean;
error: Error | null;
refetch: () => Promise<void>;
};
/**
* Hook for fetching recent transactions
*/
export declare function useRecentTransactions(limit?: number): {
transactions: Transaction[];
loading: boolean;
error: Error | null;
refetch: () => Promise<void>;
};
/**
* Hook for fetching account balance
*/
export declare function useAccountBalance(accountId?: string): {
balance: AccountBalance | null;
loading: boolean;
error: Error | null;
refetch: () => Promise<void>;
};
/**
* Hook for fetching total balance across all accounts
*/
export declare function useTotalBalance(): {
totalBalance: {
total: number;
byCurrency: Map<string, number>;
accounts: AccountBalance[];
} | null;
loading: boolean;
error: Error | null;
refetch: () => Promise<void>;
};
/**
* Hook for real-time transaction updates (polling-based)
* @deprecated Use useTransactionMonitoring for FinanceKit native change streams
*/
export declare function useTransactionStream(accountId?: string, pollingInterval?: number): {
transactions: Transaction[];
loading: boolean;
error: Error | null;
refetch: () => Promise<void>;
};
/**
* Hook for real-time transaction monitoring using FinanceKit change streams
* Provides batched updates when transactions are inserted, updated, or deleted
*/
export declare function useTransactionMonitoring(accountIds?: string[], options?: {
autoStart?: boolean;
onChanges?: (payload: TransactionsChangedPayload) => void;
}): {
isMonitoring: boolean;
error: Error | null;
changeCount: number;
start: () => Promise<void>;
stop: () => Promise<void>;
};
//# sourceMappingURL=useFinanceKit.d.ts.map