options.go

// Copyright 2020 The NATS Authors
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package jsm

import (
	"time"

	"github.com/nats-io/jsm.go/api"
)

// Option is a option to configure the JetStream Manager
type Option func(o *Manager)

// WithAPIValidation validates responses sent from the NATS server using a validator
func WithAPIValidation(v api.StructValidator) Option {
	return func(o *Manager) {
		o.validator = v
	}
}

// WithTrace enables logging of JSON API requests and responses
func WithTrace() Option {
	return func(o *Manager) {
		o.trace = true
	}
}

// WithTimeout sets a timeout for the requests
func WithTimeout(t time.Duration) Option {
	return func(o *Manager) {
		o.timeout = t
	}
}

// WithAPIPrefix replace API endpoints like $JS.API.STREAM.NAMES with prefix.STREAM.NAMES
func WithAPIPrefix(s string) Option {
	return func(o *Manager) {
		o.apiPrefix = s
	}
}

// WithEventPrefix replace event subjects like $JS.EVENT.ADVISORY.API with prefix.ADVISORY
func WithEventPrefix(s string) Option {
	return func(o *Manager) {
		o.eventPrefix = s
	}
}

// WithDomain sets a JetStream domain, incompatible with WithApiPrefix()
func WithDomain(d string) Option {
	return func(o *Manager) {
		o.domain = d
	}
}

// WithPedanticRequests enables pedantic mode in certain API calls that would avoid the server changing user configurations during request handling
func WithPedanticRequests() Option {
	return func(o *Manager) {
		o.pedantic = true
	}
}