Web/API/PublicKeyCredentialRequestOptions/timeout
Secure contextThis feature is available only in secure contexts (HTTPS), in some or all supporting browsers.
The timeout
property, of the PublicKeyCredentialRequestOptions
dictionary, represents an hint, given in milliseconds, for the time the script is willing to wait for the completion of the retrieval operation.
This property is optional and merely is a hint which may be overridden by the browser.
Note: An analogous option exists for the creation operation (navigators.credentials.create()
), see PublicKeyCredentialCreationOptions.timeout
.
Syntax
timeout = publicKeyCredentialRequestOptions.timeout
Value
A numerical hint, expressed in milliseconds, giving the time to wait for the creation operation to complete.
Examples
var options = {
challenge: new Uint8Array([/* bytes sent from the server */]),
timeout: 6000 // Wait a minute for the fetching operation
// and maybe fail if it takes longer
};
navigator.credentials.get({ "publicKey": options })
.then(function (credentialInfoAssertion) {
// send assertion response back to the server
// to proceed with the control of the credential
}).catch(function (err) {
console.error(err);
});
Specifications
Specification | Status | Comment |
---|---|---|
Web Authentication: An API for accessing Public Key Credentials Level 1The definition of 'timeout' in that specification. | Recommendation | Initial definition. |
Browser compatibility
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Update compatibility data on GitHub
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Chrome
Full support 67 |
Edge
Full support ≤79 |
Firefox
Full support 60 |
IE
No support No |
Opera
Full support 54 |
Safari
Full support 13 |
WebView Android
Full support 67 |
Chrome Android
Full support 67 |
Firefox Android
? |
Opera Android
Full support 48 |
Safari iOS
Full support 13.3 |
Samsung Internet Android
No support No |
Legend
- Full support
- Full support
- No support
- No support
- Compatibility unknown
- Compatibility unknown
- Experimental. Expect behavior to change in the future.'
- Experimental. Expect behavior to change in the future.
See also
PublicKeyCredentialCreationOptions.timeout
, the analogous option property used when creating a credential.
PublicKeyCredentialRequestOptions.timeout by Mozilla Contributors is licensed under CC-BY-SA 2.5.