PublicKeyCredentialRequestOptions.timeout

Secure context
This 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 1
The definition of 'timeout' in that specification.
Candidate Recommendation Initial definition.

Browser compatibility

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxInternet ExplorerOperaSafariAndroid webviewChrome for AndroidFirefox for AndroidOpera for AndroidSafari on iOSSamsung Internet
timeout
Experimental
Chrome Full support 67Edge ? Firefox Full support 60IE ? Opera Full support YesSafari ? WebView Android Full support 67Chrome Android Full support 67Firefox Android ? Opera Android Full support YesSafari iOS ? Samsung Internet Android ?

Legend

Full support  
Full support
Compatibility unknown  
Compatibility unknown
Experimental. Expect behavior to change in the future.
Experimental. Expect behavior to change in the future.

See also