Categorygithub.com/go-joe/file-memory
modulepackage
1.0.0
Repository: https://github.com/go-joe/file-memory.git
Documentation: pkg.go.dev
Overview
Versions
2
Dependencies
7
Dependents
2
Files
145 SLOC

# README

Joe Bot - File Storage

Basic file storage memory adapater. https://github.com/go-joe/joe

This repository contains a module for the Joe Bot library.

Getting Started

This library is packaged as Go module. You can get it via:

go get github.com/go-joe/file-memory

Example usage

b := &ExampleBot{
	Bot: joe.New("example", file.Memory("foobar.json")),
}

Built With

  • testify - A simple unit test library
  • zap - Blazing fast, structured, leveled logging in Go

Contributing

If you want to hack on this repository, please read the short CONTRIBUTING.md guide first.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • Friedrich Große - Initial work - fgrosse
  • Stefan Warman - Unit tests - warmans

See also the list of contributors who participated in this project.

License

This project is licensed under the BSD-3-Clause License - see the LICENSE file for details.

# Functions

Memory is a joe.Option which is supposed to be passed to joe.New(…) to configure a new bot.
NewMemory creates a new Memory instance that persists all values to the given path.
WithLogger is a memory option that allows the caller to set a different logger.

# Type aliases

Option corresponds to a configuration setting of the file memory.