financesyncjs v1.2.1
FinanceSyncJS
FinanceSyncJS provides a seamless integration layer between BalanceBookJS and Firebase, facilitating persistent financial data storage. This library simplifies the process of connecting your accounting logic handled by BalanceBookJS with the robust, scalable, and flexible storage capabilities of Firebase. It's designed to help developers integrate financial data management into applications effortlessly with minimal setup.
Features
- Easy setup for connecting BalanceBookJS to Firebase.
- Manage your financial records and accounting data with simple functions calls.
Firebase Configuration
FinanceSyncJS uses Firebase to manage persistent data storage. Here's how you can set up and manage your Firebase configuration.
initFirebase(config)
Initializes the Firebase application with a given configuration. This is essential to start using any Firebase services.
Parameters
config
(Object): The Firebase configuration object which includes all the necessary details like apiKey, authDomain, projectId, etc.
Returns
- The initialized Firebase application instance.
Example Usage
import { initFirebase } from 'FinanceSyncJS';
const firebaseConfig = {
apiKey: "your-api-key",
authDomain: "your-project-id.firebaseapp.com",
projectId: "your-project-id"
};
const firebaseApp = initFirebase(firebaseConfig);
getFirebaseApp()
Retrieves the currently initialized Firebase application instance. Use this to access Firebase services after initialization.
Returns
- The Firebase application instance.
Throws
- Error if Firebase is not initialized.
Example Usage
import { getFirebaseApp } from 'FinanceSyncJS';
try {
const firebaseApp = getFirebaseApp();
console.log('Firebase App is ready to use.');
} catch (error) {
console.error('Error fetching Firebase App:', error);
}