toolkit

package module

v0.0.0-...-ed23637 Latest Latest Go to latest Published: Feb 26, 2023 License: MIT Imports: 10 Imported by: 0

Details

A simple example of how to create a reusable Go module with commonly used tools.

The included tools are:

Read JSON
Write JSON
Produce a JSON encoded error response
Upload a file to a specified directory
Download a static file
Get a random string of length n
Post JSON to a remote service
Create a directory, including all parent directories, if it does not already exist
Create a URL safe slug from a string

go get -u github.com/tsawler/toolbox

This section is empty.

This section is empty.

This section is empty.

type Tools struct {
	MaxFileSize    int
	AllowFileTypes []string
}

Tools is the type used to instantiate this module. Any variable of this type, will have access to all the methods with the receiver *Tools

func (t *Tools) CreateDirIfNotExist(path string) error

func (t *Tools) DownloadStaticFile(w http.ResponseWriter, r *http.Request, p, file, displayName string)

func (t *Tools) RandomString(n int) string

RandomString returns a string of random characters of length n , using RandomStringSource

func (t *Tools) Sluggify(s string) (string, error)

func (t *Tools) UploadFiles(r *http.Request, uploadDir string, rename ...bool) ([]*UploadedFile, error)

func (t *Tools) UploadOneFile(r *http.Request, uploadDir string, rename ...bool) (*UploadedFile, error)

type UploadedFile struct {
	NewFileName      string
	OriginalFileName string
	FileSize         int64
}

UploadedFile is a struct used to save information about an uploaded file