mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-12 00:35:47 +00:00
4e49b6a99c
Use example.com instead of ripple.com Co-authored-by: Elliot Lee <github.public@intelliot.com>
26 lines
740 B
Plaintext
26 lines
740 B
Plaintext
## getSettings
|
|
|
|
`getSettings(address: string, options: object): Promise<object>`
|
|
|
|
Returns settings for the specified account. Note: For account data that is not modifiable by the user, see [getAccountInfo](#getaccountinfo).
|
|
|
|
### Parameters
|
|
|
|
<%- renderSchema('input/get-settings.json') %>
|
|
|
|
### Return Value
|
|
|
|
This method returns a promise that resolves with an array of objects with the following structure. All fields are optional, and are omitted if they are set to their default value.
|
|
|
|
<%- renderSchema('output/get-settings.json') %>
|
|
|
|
### Example
|
|
|
|
```javascript
|
|
const address = 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59';
|
|
return api.getSettings(address).then(settings =>
|
|
{/* ... */});
|
|
```
|
|
|
|
<%- renderFixture('responses/get-settings.json') %>
|