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
Web Authentication: An API for accessing Public Key Credentials - Level 3 (Web Authentication)
# dom-publickeycredentialrequestoptions-timeout

Browser compatibility

BCD tables only load in the browser

See also