NDEFReader.scan()

Draft

This page is not complete.

Secure context

This feature is available only in secure contexts (HTTPS), in some or all supporting browsers.

Experimental

This is an experimental technology
Check the Browser compatibility table carefully before using this in production.

The scan() method of NDEFReader interface reads NDEF records from compatible NFC devices, e.g., NDEF NFC tags.

Syntax

var readerPromise = NDEFReader.scan(options);

Parameters

options Optional
  • signal -- optional AbortSignal that allows to cancel this scan() operation.

Return value

A Promise that resolves with undefined immediately after scheduling read operations for the NFC adapter.

Exceptions

This method doesn't throw true exceptions; instead, it rejects the returned promise, passing into it a DOMException whose name is one of the following:

AbortError
The scan operation was aborted with AbortSignal passed in options.
InvalidStateError
There's already an ongoing scan.
NotAllowedError
The permission for this operation was rejected.
NotSupportedError
There is no NFC adapter compatible with Web NFC, or a connection can not be established.

Specifications

Specification Status Comment
Web NFC, scan() Draft Initial definition.

Browser compatibility

BCD tables only load in the browser