Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

apkg-reader

alemayhu52MIT1.1.0TypeScript support: included

a library for reading your APKG files in JavaScript

anki, apkg, apkg.js, read apkg

readme

APKG Reader

JavaScript library for reading the APKG format.

What is an APKG file?

An APKG file is a custom deck of flashcards created for use in Anki, a flashcard-based studying program. It contains HTML data used for card presentation as well as text, images, and sounds. Users can create their own Anki flashcard decks or import others' by selecting the Create Deck or Get Shared buttons found in the app. Source

Usage

import { readDatabaseFrom, ZipHandler } from "apkg-reader.js";

const data =  new ZipHandler("path/to/apkg")
const db = await readDatabaseFrom(data);

changelog

Changelog

1.0.1 (2024-12-15)

Bug Fixes

  • only publish dist files (9acae03)

1.0.0 (2024-12-15)

Features

  • add support for reading modern APKG (1fca4a4)
  • setup build process (7f6f6de)
  • start reading the media table (d50e7f5)

Bug Fixes