readme md

main
serr 2025-01-06 01:17:53 +03:00
parent 5a4db2dfd4
commit 86a95fe61d
1 changed files with 9 additions and 3 deletions

View File

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