Skip to content

A local-first personal finance app

Update to match v5 API

Jed Fox3ddfcc4dbfc0
diff --git a/docs/Developers/types.js b/docs/Developers/types.js
index b1cd6fcfe7..4e52a5ef90 100644
--- a/docs/Developers/types.js
+++ b/docs/Developers/types.js
@@ -303,8 +303,8 @@ function Argument({ arg }) {
if (arg.properties) {
return (
<span>
- {arg.name}
- {': { '}
+ {arg.name ? arg.name + ': ' : ''}
+ {'{ '}
{arg.properties
.map((prop) => <Argument arg={prop} />)
.map(insertCommas)}
diff --git a/docs/Developers/using-the-API.md b/docs/Developers/using-the-API.md
index 75a46b465d..5fdcbdb4b6 100644
--- a/docs/Developers/using-the-API.md
+++ b/docs/Developers/using-the-API.md
@@ -34,14 +34,14 @@ If you’re able to run the `@actual-app/api` package on the same computer that
let api = require('@actual-app/api');
await api.init({
- // This is the UUID from Settings → Show advanced settings → Budget ID
- budgetId: 'abcdef',
- config: {
- // This is the path to the `user-files` folder created by actual-server
- dataDir: '/path/to/user-files',
- },
+ // This is the path to the `user-files` folder created by actual-server
+ // (including the `user-files` part)
+ dataDir: '/path/to/user-files',
});
+// This is the ID from Settings → Show advanced settings → Budget ID
+await api.loadBudget('abcdef');
+
let budget = await api.getBudgetMonth('2019-10');
console.log(budget);
await api.shutdown();
@@ -94,7 +94,7 @@ These are the public methods that you can use. The API also exports low-level fu
#### `init`
-<Method name="init" argsObject={true} args={[{ name: 'options', properties: [{ name: 'budgetId', type: 'string'}, { name: 'config', properties: [{ name: 'dataDir', type: 'string' }, { name: 'serverURL', type: 'string' }]}] }]} returns="Promise<void>" />
+<Method name="init" argsObject={true} args={[{ properties: [{ name: 'dataDir', type: 'string' }, { name: 'serverURL', type: 'string' }]}]} returns="Promise<void>" />
Call this before attempting to use any of the API methods. This will connect to the server and load the budget data.