ethers.js/docs.wrm/api/utils/web.wrm

70 lines
2.2 KiB
Plaintext
Raw Normal View History

2020-05-08 10:24:40 +03:00
_section: Web Utilities @<web>
2020-02-18 01:56:13 +03:00
2020-05-08 10:24:40 +03:00
_property: ethers.utils.fetchJson(urlOrConnectionInfo [, json [ , processFunc ] ]) => Promise<any> @<utils-fetchJson>
2020-02-18 01:56:13 +03:00
Fetch and parse the JSON content from //urlOrConnectionInfo//, with the
2020-11-23 07:03:50 +03:00
optional body //json// and optionally processing the result with //processFun//
2020-02-18 01:56:13 +03:00
before returning it.
2020-05-08 10:24:40 +03:00
_property: ethers.utils.poll(pollFunc [, options ]) => Promise<any> @<utils-poll>
Repeatedly call pollFunc using the [[PollOptions]] until it returns a
2020-02-18 01:56:13 +03:00
value other than undefined.
2020-05-08 10:24:40 +03:00
_heading: ConnectionInfo @<ConnectionInfo>
2020-02-18 01:56:13 +03:00
_property: connection.url => string
The URL to connect to.
_property: connection.user => string
The username to use for [[link-wiki-basicauth]].
The default is null (i.e. do not use basic authentication)
_property: connection.password => string
The password to use for [[link-wiki-basicauth]].
The default is null (i.e. do not use basic authentication)
_property: connection.allowInsecureAuthentication => boolean
Allow [[link-wiki-basicauth]] over non-secure HTTP. The default is false.
_property: connection.timeout => number
How long to wait before rejecting with a //timeout// error.
_property: connection.headers => { [ key: string]: string }
Additional headers to include in the connection.
2020-05-08 10:24:40 +03:00
_heading: PollOptions @<PollOptions>
2020-02-18 01:56:13 +03:00
_property: options.timeout => number
2020-10-03 19:30:15 +03:00
The amount of time allowed to elapse before triggering a timeout
2020-02-18 01:56:13 +03:00
error.
_property: options.floor => number
The minimum time limit to allow for [[link-wiki-backoff]].
The default is 0s.
_property: options.ceiling => number
The maximum time limit to allow for [[link-wiki-backoff]].
The default is 10s.
_property: options.interval => number
The interval used during [[link-wiki-backoff]] calculation.
The default is 250ms.
_property: options.retryLimit => number
The number of times to retry in the event of an error or //undefined// is
returned.
2020-05-08 10:24:40 +03:00
_property: options.onceBlock => [[Provider]]
2020-02-18 01:56:13 +03:00
If this is specified, the polling will wait on new blocks from
//provider// before attempting the //pollFunc// again.
2020-05-08 10:24:40 +03:00
_property: options.oncePoll => [[Provider]]
If this is specified, the polling will occur on each poll
cycle of //provider// before attempting the //pollFunc//
again.