Exported function returning value of unexported type RVV-B0011
Anti-pattern
Critical
2 months ago
—
2 years old
exported func BlueGreenStrategy returns unexported type *deploy.blueGreen, which can be annoying to use
74 rollbackLog RollbackLog
75}
76
77func BlueGreenStrategy(md *machineDeployment, blueMachines []*machineUpdateEntry) *blueGreen { 78 bg := &blueGreen{
79 greenMachines: machineUpdateEntries{},
80 blueMachines: blueMachines,
Description
An exported function or method returning a value of an unexported type may be frustrating to use.
In Go, if the function or method starts with a lowercase letter, it is not exported outside the package.
Bad practice
type unexportedType string
func ExportedFunc() *unexportedType {
return &unexportedType("some string")
}
Recommended
type ExportedType string
func ExportedFunc() *ExportedType {
return &ExportedType("some string")
}