Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BasketInfo ¶
type Pantry ¶
type Pantry struct {
// GetDetails returns the details of the pantry
GetDetails func() (PantryInfo, error)
// UpdateDetails updates the details of the pantry
UpdateDetails func(info UpdatedInfo) (PantryInfo, error)
// CreateOrReplaceBasket creates or replaces a basket in the pantry
// with the given name and data and returns true if successful
CreateOrReplaceBasket func(name string, data any) (bool, error)
// UpdateBasketContent updates the content of the basket
// with the given name and returns the updated data
UpdateBasketContent func(name string, data any) (any, error)
// GetBasketContent returns the content of the basket
// with the given name in the given format
GetBasketContent func(name string, format any) (any, error)
// DeleteBasket deletes the basket with the given name
// and returns true if successful
// THIS WILL DELETE ALL THE DATA IN THE BASKET
DeleteBasket func(name string) (bool, error)
// HasBasket checks if the pantry has a basket with the given name
HasBasket func(name string) (bool, error)
}
func CreatePantry ¶
func CreateRateLimitedPantry ¶
CreatePantry creates a new rateLimited Pantry API Wrapper with the given API key
type PantryInfo ¶
type UpdatedInfo ¶
Click to show internal directories.
Click to hide internal directories.