Skip to content

Latest commit

 

History

History
79 lines (66 loc) · 2.02 KB

README.md

File metadata and controls

79 lines (66 loc) · 2.02 KB
id title
memory
Memory

Release Discord Test Security Linter

An in-memory storage driver.

Note: Requires Go 1.19 and above

Table of Contents

Signatures

func New(config ...Config) Storage
func (s *Storage) Get(key string) ([]byte, error)
func (s *Storage) Set(key string, val []byte, exp time.Duration) error
func (s *Storage) Delete(key string) error
func (s *Storage) Reset() error
func (s *Storage) Close() error
func (s *Storage) Conn() map[string]entry
func (s *Storage) Keys() ([][]byte, error)

Installation

Memory is tested on the 2 last Go versions with support for modules. So make sure to initialize one first if you didn't do that yet:

go mod init github.com/<user>/<repo>

And then install the memory implementation:

go get github.com/gofiber/storage/memory/v2

Examples

Import the storage package.

import "github.com/gofiber/storage/memory/v2"

You can use the following possibilities to create a storage:

// Initialize default config
store := memory.New()

// Initialize custom config
store := memory.New(memory.Config{
	GCInterval: 10 * time.Second,
})

Config

type Config struct {
	// Time before deleting expired keys
	//
	// Default is 10 * time.Second
	GCInterval time.Duration
}

Default Config

var ConfigDefault = Config{
	GCInterval: 10 * time.Second,
}