cantrips

README

Go Cantrips

Cantrips is a collection of useful functions in the Go Programming Language

What are Cantrips?

NOTE

/ ˈkɑn trɪp / noun

1. chiefly Scotland: a magic spell; trick by sorcery.
2. chiefly British: hocus-pocus.
   
   

Cantrips are small (magical) utility functions to achieve common tasks in Go. The name was inspired by Svelte 5's Runes and Baldur's Gate 3.

For example the Pop() function will remove the last element from a slice and return that element.

package main

import (
	"fmt"
	"github.com/banaaron/cantrips"
)

func main() {
	names := []string{"aaron", "chris", "drew"}
	n := cantrips.Pop(&names)
	fmt.Println(n)     // "drew"
	fmt.Println(names) // ["aaron", "chris"]

	// you can provide an index to remove an element at a specific index
	p := cantrips.Pop(&names, 1)
	fmt.Println(p)     // "chris"
	fmt.Println(names) // ["aaron"]
}

Documentation

Index

• func Pop[T any](slice *[]T, index ...int) (popped T)
• func ReverseString(input string) string
• func SortKeys[Key ordered, Value any](input map[Key]Value, reverse ...bool) (keys []Key)
• func ToLower(input string) string
• func ToTitle(input string) string
• func ToUpper(input string) string

Functions

func Pop

func Pop[T any](slice *[]T, index ...int) (popped T)

Pop removes last element from a slice.

Returns the removed element.

slice: pointer to a slice of any type

index (optional): index of the element you wish to removed.

func ReverseString

func ReverseString(input string) string

ReverseString reverses a string

func SortKeys

func SortKeys[Key ordered, Value any](input map[Key]Value, reverse ...bool) (keys []Key)

SortKeys returns a slice of keys in ascending order.

input: a map with int, float, or string keys

reverse: keys will be in descending order if set to true

func ToLower

func ToLower(input string) string

func ToTitle

func ToTitle(input string) string

func ToUpper

func ToUpper(input string) string