readme md

main
serr 2025-01-06 01:13:25 +03:00
parent f79243bc42
commit 6a0fe5a584
1 changed files with 22 additions and 2 deletions

View File

@ -4,7 +4,7 @@
## Установка
Для использования CandyCache в вашем проекте, установить его, используя **go get git.hikan.ru/serr/candycache**
Для использования CandyCache в вашем проекте, установите его, используя **go get git.hikan.ru/serr/candycache**, далее просто добавьте в блок импорта.
## Основные возможности
@ -12,3 +12,23 @@
- **Возможность ручного управления**
- **Безопасность**: конкурентный доступ к данным возможен благодаря мьютексам
- **Гибкость**: кэш может хранить любые типы данных
## Использование
# Создание кэша
Для создания нового экземпляра кэша используйте функцию **Cacher**, передавая интервал очистки в наносекундах:
```cache := candycache.Cacher(10 * time.Minute) // Очистка каждые 10 минут```
# Добавление элемента
Для добавления элемента в кэш используйте метод **Add**:
```cache.Add("key", "value", 5 * time.Minute) // Элемент будет храниться 5 минут```
В случае, если по указанном ключу уже что-то хранится, оно будет заменено на новый элемент.
# Получение элемента
Для получения элемента из кэша используйте метод **Get**:
```value, found := cache.Get("key") // Получение значения по ключу "key"```
Если элемент найден, то в переменную **value** будет записано значение, а в **found****true**. Если элемент не найден, то в **found** будет записано **false**, а значением вернется **nil**