Improve documentation on quota.triggers[]

This commit is contained in:
Rory Powell 2022-10-12 11:38:16 +01:00
parent e92a31bd45
commit 34bd4b15df
1 changed files with 7 additions and 0 deletions

View File

@ -89,5 +89,12 @@ export type Quotas = {
export interface Quota { export interface Quota {
name: string name: string
value: number value: number
/**
* Array of whole numbers (1-100) that dictate the percentage that this quota should trigger
* at in relation to the corresponding usage inside budibase.
*
* Triggering results in a budibase installation sending a request to account-portal,
* which can have subsequent effects such as sending emails to users.
*/
triggers: number[] triggers: number[]
} }