Package Exports
- barcodefyi
Readme
barcodefyi
TypeScript API client for BarcodeFYI -- the comprehensive barcode reference covering 50+ symbologies across 1D and 2D families, GS1 standards, encoding components, and industry applications from retail UPC/EAN to healthcare GS1 DataMatrix. Zero dependencies, uses native fetch.
Explore barcodes at barcodefyi.com -- Symbologies | Standards | Glossary | API Docs
Install
npm install barcodefyiWorks in Node.js, Deno, Bun, and browsers (ESM).
Quick Start
import { BarcodeFYI } from "barcodefyi";
const api = new BarcodeFYI();
// Search symbologies, standards, glossary
const results = await api.search("ean-13");
// Get symbology detail
const code128 = await api.symbology("code-128");
console.log(code128.encoding_type); // "Linear"
console.log(code128.character_set); // "Full ASCII (128 characters)"
// Compare two symbologies
const comparison = await api.compare("upc-a", "ean-13");
// Get industry applications
const retail = await api.industry("retail");API Methods
| Method | Description |
|---|---|
search(query) |
Search symbologies, standards, components, glossary |
glossaryTerm(slug) |
Get glossary term definition |
symbology(slug) |
Barcode symbology detail |
family(slug) |
Barcode family detail |
standard(slug) |
Barcode standard detail |
component(slug) |
Barcode component detail |
industry(slug) |
Industry application detail |
compare(slugA, slugB) |
Compare two symbologies |
random() |
Random barcode symbology |
openapi() |
OpenAPI 3.1.0 specification |
TypeScript Types
import type {
SearchResult, SymbologyDetail, FamilyDetail, StandardDetail,
ComponentDetail, GlossaryTerm, CompareResult, IndustryDetail,
} from "barcodefyi";Also Available
| Language | Package |
|---|---|
| Python | barcodefyi 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