Function IncludeHistory

jetstream/kv_options.go:29–37

IncludeHistory instructs the key watcher to include historical values as well (up to KeyValueMaxHistory).

()

// IncludeHistory instructs the key watcher to include historical values as
// well (up to KeyValueMaxHistory).
func IncludeHistory() WatchOpt {
	return watchOptFn(func(opts *watchOpts) error {
		if opts.updatesOnly {
			return fmt.Errorf("%w: include history cannot be used with updates only", ErrInvalidOption)
		}
		opts.includeHistory = true
		return nil
	})
}

// UpdatesOnly instructs the key watcher to only include updates on values
// (without latest values when started).