Web/API/NDEFReader/scan

Draft This page is not complete.

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

This is an experimental technologyCheck 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

;* 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

Specification	Status	Comment
Web NFC, scan()	Draft	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	Edge	Firefox	Internet Explorer	Opera	Safari	Android webview	Chrome for Android	Firefox for Android	Opera for Android	Safari on iOS	Samsung Internet
scan Experimental'	Chrome No support No	Edge No support No	Firefox No support No	IE No support No	Opera No support No	Safari No support No	WebView Android No support No	Chrome Android No support No	Firefox Android No support No	Opera Android No support No	Safari iOS No support No	Samsung Internet Android No support No

Legend

No support  

No support

Experimental. Expect behavior to change in the future.'

Experimental. Expect behavior to change in the future.

NDEFReader.scan() by Mozilla Contributors is licensed under CC-BY-SA 2.5.