network

package

v1.1.0 Latest Latest Go to latest Published: Jun 13, 2024 License: MIT Imports: 4 Imported by: 0

Details

This section is empty.

This section is empty.

This section is empty.

type Network struct {
	Alias string
	Type  NetworkType
	// contains filtered or unexported fields
}

Network is a type that represents a network

func NewNetwork(opts ...NetworkOption) *Network

NewNetwork creates a new Network

func (ntw *Network) Build(ctx context.Context) (*testcontainers.DockerNetwork, error)

Build creates a new DockerNetwork

type NetworkOption func(*Network)

NetworkOption is a type that represents a network option

func WithAlias(alias string) NetworkOption

WithAlias is a NetworkOption that sets the alias of the network

Default: network

func WithType(typeName NetworkType) NetworkOption

WithType is a NetworkOption that sets the type of the network

Default: bridge

type NetworkType string

NetworkType is a type that represents the type of network

var (
	// NetworkTypeBridge is a network type that represents a bridge network
	NetworkTypeBridge NetworkType = "bridge"
)