Categorygithub.com/dheidemann/anki-go
modulepackage
0.0.0-20240401185028-6e46c7498302
Repository: https://github.com/dheidemann/anki-go.git
Documentation: pkg.go.dev

# README

Build Status GoDoc

A library to read Anki *.apkg packages in Go and GopherJS, licensed under the AGPLv3.

# Functions

No description provided by the author
ReadBytes reads an *.apkg file from a bytestring, returning an Apkg struct for processing.
ReadFile reads an *.apkg file, returning an Apkg struct for processing.
ReadReader reads an *.apkg file from an io.Reader, returning an Apkg struct for processing.

# Constants

Buried.
Learning.
New/Cram.
Day Learn (Relearn?).
Review.
Sched Buried (??, possibly unused).
Suspended.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ModelTypeCloze indicates an Anki Cloze note type.
ModelTypeStandard indicates an Anki Basic note type.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author

# Structs

Apkg manages state of an Anki package file during processing.
Card definition This definition excludes the `flags` and `data` fields, which are no longer used.
A card constraint defines which fields are necessary for a particular card type to be generated.
Cards is a wrapper around sqlx.Rows, which means that any standard sqlx.Rows or sql.Rows methods may be called on it.
Collection is an Anki Collection, stored in the `col` table.
Config represents basic global configuration for the Anki client.
No description provided by the author
A Deck definition.
Per-Deck configuration options.
A field of a model Excluded from this definition is the `media` field, which appears to no longer be used.
Model (aka Note Type) Excluded from this definition is the `vers` field, which is no longer used by Anki.
Note definition Excludes the `flags` and `data` columns, which are no longer used.
Notes is a wrapper around sqlx.Rows, which means that any standard sqlx.Rows or sql.Rows methods may be called on it.
Review definition `ivl` is stored either as negative seconds, or as positive days.
No description provided by the author
A Template definition.

# Type aliases

BoolInt represents a boolean value stored as an int.
No description provided by the author
No description provided by the author
Collection of per-deck configurations.
A collection of Decks.
DurationDays represents a duration in days.
DurationMilliseconds represents a time.Duration value stored as milliseconds.
DurationMinutes represents a time.Duration value stored as minutes.
DurationSeconds represents a time.Duration value stored as seconds.
No description provided by the author
ID represents an Anki object ID (deck, card, note, etc) as an int64.
Enum of available leech actions.
Models is a collection of Models (aka note types), stored as JSON in the `models` column of the `col` table.
Enum representing the available Note Type Types (confusing, eh?).
Enum of new card order options.
No description provided by the author
No description provided by the author
The Tags type represents an array of tags for a note.
TimestampMilliseconds represents a time.Time value stored as milliseconds.
TimestampSeconds represents a time.Time value stored as seconds.