SudoSOS Back-end API / balance / BalanceService
Class: BalanceService ​
Extends ​
Constructors ​
Constructor ​
ts
new BalanceService(manager?): BalanceService;Parameters ​
| Parameter | Type |
|---|---|
manager? | EntityManager |
Returns ​
BalanceService
Inherited from ​
Properties ​
| Property | Modifier | Type | Inherited from |
|---|---|---|---|
manager | protected | EntityManager | WithManager.manager |
Methods ​
calculateTotalBalances() ​
ts
calculateTotalBalances(date, allowDeleted?): Promise<TotalBalanceResponse>;Get the total balance of SudoSOS and
Parameters ​
| Parameter | Type | Description |
|---|---|---|
date | Date | Date to check the balances for |
allowDeleted? | boolean | allow balances of deleted users to be returned |
Returns ​
Promise<TotalBalanceResponse>
clearBalanceCache() ​
ts
clearBalanceCache(ids?): Promise<void>;Clear balance cache
Parameters ​
| Parameter | Type |
|---|---|
ids? | number | number[] |
Returns ​
Promise<void>
getBalance() ​
ts
getBalance(id, date?): Promise<BalanceResponse>;Get balance for single user
Parameters ​
| Parameter | Type | Description |
|---|---|---|
id | number | ID of user |
date? | Date | Date to calculate balance for |
Returns ​
Promise<BalanceResponse>
getBalances() ​
ts
getBalances(ids, pagination?): Promise<[BalanceResponse[], number]>;Get balance of users with given IDs
Parameters ​
| Parameter | Type | Description |
|---|---|---|
ids | GetBalanceParameters | ids of users to get balance of |
pagination | PaginationParameters | pagination options |
Returns ​
Promise<[BalanceResponse[], number]>
the balances and total count
updateBalances() ​
ts
updateBalances(params): Promise<void>;Update the balance cache with active values Insafe Query! Safety leveraged by type safety
Parameters ​
| Parameter | Type |
|---|---|
params | UpdateBalanceParameters |
Returns ​
Promise<void>