utils

Documentation

Index

• Constants
• func GetCurrencyID() string
• func GetFavourites() map[string]bool
• func GetPortfolio() map[string]float64
• func LoopTick(ctx context.Context, t time.Duration, action func(errChan chan error)) error
• func MaxFloat64(a ...float64) float64
• func MinFloat64(a ...float64) float64
• func RoundValues(num1, num2 float64) ([]float64, string)
• func SaveMetadata(favourites map[string]bool, currency string, portfolio map[string]float64) error
• func SortData(data [][]string, sortIdx int, sortAsc bool, sortCase string)
• type AllCurrencyData
• type Currency
• type Metadata

Constants

const (
	// UpArrow provides the symbol for increase
	UpArrow = "▲"
	// DownArrow provides the symbol for decrease
	DownArrow = "▼"
)

Functions

func GetCurrencyID

func GetCurrencyID() string

GetCurrencyID returns the currencyID stored from metadata

func GetFavourites

func GetFavourites() map[string]bool

GetFavourites reads stored favourite coin details from ~/.cryptgo-data.json and returns a map.

func GetPortfolio

func GetPortfolio() map[string]float64

GetPortfolio reads stored portfolio details from ~/.cryptgo-data.json and returns a map.

func LoopTick

func LoopTick(ctx context.Context, t time.Duration, action func(errChan chan error)) error

LoopTick runs a given action in a loop in periods of 't' duration. It exits when the context is cancelled

func MaxFloat64

func MaxFloat64(a ...float64) float64

MaxFloat64 returns maximum float from a given number of floats

func MinFloat64

func MinFloat64(a ...float64) float64

MinFloat64 returns minimum float from a given number of floats

func RoundValues

func RoundValues(num1, num2 float64) ([]float64, string)

RoundValues rounds off a pair of given floats to Thousands (kilo), Millions (mega) or Billions (giga).

func SaveMetadata

func SaveMetadata(favourites map[string]bool, currency string, portfolio map[string]float64) error

SaveMetadata exports favourites, currency and portfolio to disk. Data is saved on ~/.cryptgo-data.json

func SortData

func SortData(data [][]string, sortIdx int, sortAsc bool, sortCase string)

SortData helps sort table rows. It sorts the table based on values given in the sortIdx column and sorts ascending if sortAsc is true. sortCase is set to identify the set of 'less' functions to use to sort the selected column by.

Types

type AllCurrencyData

type AllCurrencyData struct {
	Data      []Currency `json:"data"`
	Timestamp uint       `json:"timestamp"`
}

AllCurrencyData holds data of a group of currencies fetched from CoinCap

type Currency

type Currency struct {
	ID             string `json:"id"`
	Symbol         string `json:"symbol"`
	CurrencySymbol string `json:"currencySymbol"`
	Type           string `json:"type"`
	RateUSD        string `json:"rateUsd"`
}

Currency holds currency data when fetched from CoinCap

type Metadata

type Metadata struct {
	Favourites map[string]bool    `json:"favourites"`
	Currency   string             `json:"currency"`
	Portfolio  map[string]float64 `json:"portfolio"`
}

Metadata holds persistent information to be stored to disk