NDEFReader.scan()

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

• id -- the match pattern for matching each NDEFRecord.id.
• recordType -- the match pattern for matching each NDEFRecord.recordType.
• mediaType -- the match pattern for matching each NDEFRecord.mediaType.
• signal -- optional AbortSignal that allows to cancell this scan() operation.

Return value

A Promise that resolves with undefined immediatelly 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.

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

Browser compatibility