AccountsDataTableBuilder
A AccountsDataTableBuilder is used to setup and build two-dimensional arrays containing accounts.
Constructors
Constructor
new AccountsDataTableBuilder(accounts): AccountsDataTableBuilder;Parameters
| Parameter | Type |
|---|---|
accounts | Account[] |
Returns
AccountsDataTableBuilder
Methods
archived()
archived(include): AccountsDataTableBuilder;Defines whether the archived accounts should be included.
Parameters
| Parameter | Type | Description |
|---|---|---|
include | boolean | Whether to include archived accounts |
Returns
AccountsDataTableBuilder
This builder with respective include archived option, for chaining.
build()
build(): Promise<any[][]>;Builds a two-dimensional array containing all accounts.
Returns
Promise<any[][]>
A promise resolving to a two-dimensional array containing all accounts
groups()
groups(include): AccountsDataTableBuilder;Defines whether include account groups.
Parameters
| Parameter | Type | Description |
|---|---|---|
include | boolean | Whether to include groups |
Returns
AccountsDataTableBuilder
This builder with respective include groups option, for chaining.
hiddenProperties()
hiddenProperties(include): AccountsDataTableBuilder;Defines whether to include hidden properties (keys ending with underscore ”_”). Only relevant when properties is enabled. Default is false — hidden properties are excluded.
Parameters
| Parameter | Type | Description |
|---|---|---|
include | boolean | Whether to include hidden properties |
Returns
AccountsDataTableBuilder
This builder with respective option, for chaining.
ids()
ids(include): AccountsDataTableBuilder;Defines whether include account ids.
Parameters
| Parameter | Type | Description |
|---|---|---|
include | boolean | Whether to include ids |
Returns
AccountsDataTableBuilder
This builder with respective include ids option, for chaining.
properties()
properties(include): AccountsDataTableBuilder;Defines whether include custom account properties.
Parameters
| Parameter | Type | Description |
|---|---|---|
include | boolean | Whether to include properties |
Returns
AccountsDataTableBuilder
This builder with respective include properties option, for chaining.