compress

Documentation

Index

• func ConfigAdd(path string)
• func Register(ctx context.Context, options *fiber.Options) (fiber.ConfigPlugin, fiber.AppPlugin)
• type Compress
  • func NewCompressWithConfigPath(path string) (*Compress, error)
  • func NewCompressWithOptions(options *Options) *Compress
  • func (d *Compress) Register(ctx context.Context, options *fiber.Options) (fiber.ConfigPlugin, fiber.AppPlugin)
• type Options
  • func NewOptions() (*Options, error)
  • func NewOptionsWithPath(path string) (opts *Options, err error)
  • func (o *Options) GetLevel() compress.Level

Functions

func ConfigAdd

func ConfigAdd(path string)

func Register

func Register(ctx context.Context, options *fiber.Options) (fiber.ConfigPlugin, fiber.AppPlugin)

Register registers a new compress plugin for fiber.

Types

type Compress

type Compress struct {
	// contains filtered or unexported fields
}

Compress represents a new compress plugin for fiber.

func NewCompressWithConfigPath

func NewCompressWithConfigPath(path string) (*Compress, error)

NewCompressWithConfigPath returns a new compress plugin with options from config path.

func NewCompressWithOptions

func NewCompressWithOptions(options *Options) *Compress

NewCompressWithOptions returns a new compress plugin with options.

func (*Compress) Register

func (d *Compress) Register(ctx context.Context, options *fiber.Options) (fiber.ConfigPlugin, fiber.AppPlugin)

Register registers this compress plugin for fiber.

type Options

type Options struct {
	Enabled bool
	Level   int
}

Options compress plugin for fiber options.

func NewOptions

func NewOptions() (*Options, error)

NewOptions returns options from config file or environment vars.

func NewOptionsWithPath

func NewOptionsWithPath(path string) (opts *Options, err error)

NewOptionsWithPath unmarshals options based a given key path.

func (*Options) GetLevel

func (o *Options) GetLevel() compress.Level

GetLevel returns current compress level.