Exported function returning value of unexported type RVV-B0011
Anti-pattern
6 months ago
—
6 months old
exported func CreateRouter returns unexported type *core.router, which can be annoying to use
69 return fiberApp
70}
71
72func CreateRouter() *router { 73 return &router{
74 appRoutes: make(map[string][]*ExtendedRoute),
75 projectRoutes: []*Route{},
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")
}