# README
GoCryptoTrader package cache

This cache package is part of the GoCryptoTrader codebase.
This is still in active development
You can track ideas, planned features and what's in progress on our GoCryptoTrader Kanban board.
Join our slack to discuss all things related to GoCryptoTrader! GoCryptoTrader Slack
Current Features for cache package
- Basic LRU cache system with both goroutine safe (via mutex locking) and non-goroutine safe options
How to use
Basic Usage:
package main
import ("github.com/thrasher-corp/gocryptotrader/common/cache")
func main() {
lruCache := cache.New(5)
lruCache.Add("hello", "world")
c := lruCache.Contains("hello")
if !c {
fmt.Println("expected cache to contain \"hello\" key")
}
v := lruCache.Get("hello")
if v == nil {
fmt.Println("expected cache to contain \"hello\" key")
}
fmt.Println(v)
}
Contribution
Please feel free to submit any pull requests or suggest any desired features to be added.
When submitting a PR, please abide by our coding guidelines:
- Code must adhere to the official Go formatting guidelines (i.e. uses gofmt).
- Code must be documented adhering to the official Go commentary guidelines.
- Code must adhere to our coding style.
- Pull requests need to be based on and opened against the
master
branch.
Donations

If this framework helped you in any way, or you would like to support the developers working on it, please donate Bitcoin to:
bc1qk0jareu4jytc0cfrhr5wgshsq8282awpavfahc
# Functions
New returns a new concurrent-safe LRU cache with input capacity.
NewLRUCache returns a new non-concurrent-safe LRU cache with input capacity.