option.go

package batch

import (
	"context"
	"time"
)

const (
	// DefaultBatchSize represents the default value for the size of each batch.
	DefaultBatchSize = 10
	// DefaultMaxWait represents the default value of the maximum waiting time for filling each batch.
	DefaultMaxWait = 1 * time.Second
)

// OptionFunc defines type for Options setter function.
type OptionFunc func(*Options)

// Options sets configuration options for the go-batch instance.
type Options struct {
	// Size specifies the maximum number of items that can be in a batch.
	//
	// Default: 10.
	Size int
	// MaxWait specifies the maximum waiting time for filling a batch.
	//
	// Default: 1 * time.Second.
	MaxWait time.Duration
	// Context represents the context that the Batch instance will use for its life cycle.
	//
	// Default: context.Background().
	Context context.Context
}

// WithSize sets the maximum number of items that can be in each batch.
func WithSize(size int) OptionFunc {
	return func(opts *Options) {
		opts.Size = size
	}
}

// WithMaxWait sets the maximum waiting time for filling each batch.
func WithMaxWait(maxWait time.Duration) OptionFunc {
	return func(opts *Options) {
		opts.MaxWait = maxWait
	}
}

// WithContext sets the context that the Batch instance will use for its life cycle.
func WithContext(ctx context.Context) OptionFunc {
	return func(opts *Options) {
		opts.Context = ctx
	}
}