indexeddb

Documentation

Index

• Variables
• type Batch
  • func (b *Batch) Add(key, value any) error
  • func (b *Batch) Put(key, value any) error
  • func (b *Batch) Wait() error
• type DB
  • func New(name string, version int, upgrade func(up *Upgrade) error) (*DB, error)
  • func (db *DB) Close() error
  • func (db *DB) NewTransaction(stores []string, mode Mode) (*Transaction, error)
• type Index
  • func (i *Index) Get(key any) (*js.Value, error)
• type Mode
  • func (m Mode) String() string
  • func (m Mode) Verify() bool
• type Store
  • func (s *Store) Add(key, value any) error
  • func (s *Store) Batch() *Batch
  • func (s *Store) Clear() error
  • func (s *Store) Count() (int, error)
  • func (s *Store) Delete(key any) error
  • func (s *Store) Get(key any) (*js.Value, error)
  • func (s *Store) GetAll() ([]js.Value, error)
  • func (s *Store) Index(name string) *Index
  • func (s *Store) NewIndex(name string) *Index
  • func (s *Store) Put(key any, value any) error
• type StoreConfig
• type Transaction
  • func (tx *Transaction) Store(name string) *Store
• type Upgrade
  • func (up *Upgrade) CreateStore(name string)
  • func (up *Upgrade) NewStore(name string, cfg *StoreConfig) *Store

Variables

var (
	IndexedDB = js.Global().Get("indexedDB")
	Object    = js.Global().Get("Object")
	Array     = js.Global().Get("Array")
)

var (
	ErrValueNotFound = errors.New("value not found")
	ErrKeyInvalid    = errors.New("key is invalid")
	ErrValueInvalid  = errors.New("value is invalid")
	ErrInvalidType   = errors.New("type is not accepted")
)

var Logger *slog.Logger

Types

type Batch

type Batch struct {
	// contains filtered or unexported fields
}

func (*Batch) Add

func (b *Batch) Add(key, value any) error

func (*Batch) Put

func (b *Batch) Put(key, value any) error

func (*Batch) Wait

func (b *Batch) Wait() error

type DB

type DB struct {
	// contains filtered or unexported fields
}

https://developer.mozilla.org/en-US/docs/Web/API/IDBDatabase.

func New

func New(name string, version int, upgrade func(up *Upgrade) error) (*DB, error)

func (*DB) Close

func (db *DB) Close() error

close the database.

func (*DB) NewTransaction

func (db *DB) NewTransaction(stores []string, mode Mode) (*Transaction, error)

type Index

type Index struct {
	// contains filtered or unexported fields
}

func (*Index) Get

func (i *Index) Get(key any) (*js.Value, error)

type Mode

type Mode int

const (
	ReadMode Mode = iota
	ReadWriteMode
)

func (Mode) String

func (m Mode) String() string

func (Mode) Verify

func (m Mode) Verify() bool

type Store

type Store struct {
	// contains filtered or unexported fields
}

func (*Store) Add

func (s *Store) Add(key, value any) error

func (*Store) Batch

func (s *Store) Batch() *Batch

func (*Store) Clear

func (s *Store) Clear() error

func (*Store) Count

func (s *Store) Count() (int, error)

func (*Store) Delete

func (s *Store) Delete(key any) error

func (*Store) Get

func (s *Store) Get(key any) (*js.Value, error)

get is a query for the key.

func (*Store) GetAll

func (s *Store) GetAll() ([]js.Value, error)

func (*Store) Index

func (s *Store) Index(name string) *Index

func (*Store) NewIndex

func (s *Store) NewIndex(name string) *Index

func (*Store) Put

func (s *Store) Put(key any, value any) error

put is either an insert or an update,

type StoreConfig

type StoreConfig struct {
	KeyPath       string
	AutoIncrement bool
}

type Transaction

type Transaction struct {
	// contains filtered or unexported fields
}

https://developer.mozilla.org/en-US/docs/Web/API/IDBTransaction.

func (*Transaction) Store

func (tx *Transaction) Store(name string) *Store

type Upgrade

type Upgrade struct {
	// contains filtered or unexported fields
}

an upgrade is a database connection before needing it's objects/indexes established.

func (*Upgrade) CreateStore

func (up *Upgrade) CreateStore(name string)

deprecated use `NewStore` instead.

func (*Upgrade) NewStore

func (up *Upgrade) NewStore(name string, cfg *StoreConfig) *Store