nfcfyi

TypeScript API client for NFCFYI -- the comprehensive NFC reference covering NFC chips (NTAG, MIFARE, ST25), chip families, NDEF record types, operating modes (reader/writer, peer-to-peer, card emulation), ISO 14443/ISO 15693 standards, and real-world use cases. Zero dependencies, uses native fetch.

Explore NFC at nfcfyi.com -- Chips | Standards | Glossary | API Docs

Install

npm install nfcfyi

Works in Node.js, Deno, Bun, and browsers (ESM).

Quick Start

import { NFCFYI } from "nfcfyi";

const api = new NFCFYI();

// Search NFC chips, standards, NDEF types
const results = await api.search("ntag 215");

// Get NFC chip detail
const ntag215 = await api.chip("ntag-215");
console.log(ntag215.memory_size);    // "504 bytes"
console.log(ntag215.manufacturer);   // "NXP"

// Get NDEF type detail
const uri = await api.ndefType("uri");
console.log(uri.tnf); // 1

// Compare two NFC chips
const comparison = await api.compare("ntag-215", "ntag-216");

API Methods

| Method | Description | |--------|-------------| | search(query) | Search chips, standards, NDEF types, glossary | | glossaryTerm(slug) | Get glossary term definition | | chip(slug) | NFC chip detail | | chipFamily(slug) | NFC chip family detail | | standard(slug) | NFC standard detail | | operatingMode(slug) | Operating mode detail | | ndefType(slug) | NDEF record type detail | | useCase(slug) | Use case detail | | compare(slugA, slugB) | Compare two NFC chips | | random() | Random NFC chip | | openapi() | OpenAPI 3.1.0 specification |

TypeScript Types

import type {
  SearchResult, ChipDetail, ChipFamilyDetail, StandardDetail,
  OperatingModeDetail, NdefTypeDetail, UseCaseDetail, GlossaryTerm, CompareResult,
} from "nfcfyi";

Also Available

| Language | Package | |----------|---------| | Python | nfcfyi on PyPI | | TypeScript | This package |

Code FYI Family

Part of the FYIPedia open-source developer tools ecosystem -- automatic identification and data capture technologies.

| Package | npm | Description | |---------|-----|-------------| | barcodefyi | npm | Barcode symbologies, standards -- barcodefyi.com | | qrcodefyi | npm | QR code types, versions, encoding -- qrcodefyi.com | | nfcfyi | npm | NFC chips, NDEF, standards -- nfcfyi.com | | blefyi | npm | BLE profiles, beacons, chips -- blefyi.com | | rfidfyi | npm | RFID tags, readers, frequencies -- rfidfyi.com | | smartcardfyi | npm | Smart cards, EMV, platforms -- smartcardfyi.com |

License

MIT