localstore

Documentation

Overview

Package localstore is a helper for persistent JSON storage on the users machine.

Index

• func DefaultDir(appID string) (string, error)
• func LoadJSONFile(path string, data any) error
• func StoreJSONFile(path string, data any) error

Functions

func DefaultDir

func DefaultDir(appID string) (string, error)

DefaultDir returns the default local updater storage directory given an appID.

func LoadJSONFile

func LoadJSONFile(path string, data any) error

LoadJSONFile unmarshals file contents from the given file path into a generic object. data cannot be nil. errors.Is(err, os.ErrNotExist) will return true if file doesn't exist.

func StoreJSONFile

func StoreJSONFile(path string, data any) error

StoreJSONFile marshals data from the given object into file with given path. File and directory tree will be created if they do not exist. data cannot be nil.