cache

package

v0.9.1 Latest Latest Go to latest Published: Dec 8, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

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

func NewCache(maxAge int, pathToDatabase string) (*Cache, error)

NewCache creates a cache layer instance and returns it inner workings like options are not yet available

func (c *Cache) AccountNeedUpdate() (needUpdate bool)

NeedUpdate returns true if cache needs a refresh

func (c *Cache) AccountSet(account *toggl.Account) error

AccountSet can be used to update the value of the account in the cache

func (c *Cache) ClientByID(clientID, workspace int) (client *toggl.Client, err error)

func (c *Cache) ClientMetaData(workspace int) (m *MetaData, err error)

ProjectMetaData returns meta data about the projects cache

func (c *Cache) Clients(workspace int) (clients []toggl.Client, err error)

func (c *Cache) Close() error

func (c *Cache) GetAccount() (acc toggl.Account, err error)

AccountSet can be used to update the value of the account in the cache

func (c *Cache) NeedUpdate(workspace int) bool

NeedUpdate returns true if cache needs a refresh

func (c *Cache) ProjectByID(projectID, workspace int) (project *toggl.Project, err error)

func (c *Cache) ProjectMetaData(workspace int) (m *MetaData, err error)

ProjectMetaData returns meta data about the projects cache

func (c *Cache) Projects(workspace int) (projects []toggl.Project, err error)

func (c *Cache) SetClients(workspace int, clients []toggl.Client) error

func (c *Cache) SetProjects(workspace int, projects []toggl.Project) error

SetProjects stores provided projects in cache

type MetaData struct {
	Updated    time.Time
	NextUpdate time.Time
}