fix(): typo

go-chi · Apr 9, 2024 · cb43924 · cb43924
1 parent 3433509
commit cb43924
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/middleware/realip.go b/middleware/realip.go
@@ -42,13 +42,13 @@ func RealIP(h http.Handler) http.Handler {
 	return http.HandlerFunc(fn)
 }
 
-// RealIPCustomHeader is a middleware that sets a http.Request's RemoteAddr to the results
+// RealIPFromHeaders is a middleware that sets a http.Request's RemoteAddr to the results
 // of parsing the custom headers.
 //
 // usage:
-// r.Use(RealIPCustomHeader([]string{"X-CUSTOM-IP"}))
-// r.Use(RealIPCustomHeader(append(DefaultRealIPHeaders, "X-CUSTOM-IP")))
-func RealIPCustomHeader(realIPHeaders []string) func(http.Handler) http.Handler {
+// r.Use(RealIPFromHeaders([]string{"CF-Connecting-IP"}))
+// r.Use(RealIPFromHeaders(append(DefaultRealIPHeaders, "CF-Connecting-IP")))
+func RealIPFromHeaders(realIPHeaders []string) func(http.Handler) http.Handler {
 	f := func(h http.Handler) http.Handler {
 		fn := func(w http.ResponseWriter, r *http.Request) {
 			if rip := getRealIP(r, realIPHeaders); rip != "" {

diff --git a/middleware/realip_test.go b/middleware/realip_test.go
@@ -121,7 +121,7 @@ func TestCustomIPHeader(t *testing.T) {
 	w := httptest.NewRecorder()
 
 	r := chi.NewRouter()
-	r.Use(RealIPCustomHeader([]string{customHeaderKey}))
+	r.Use(RealIPFromHeaders([]string{customHeaderKey}))
 
 	realIP := ""
 	r.Get("/", func(w http.ResponseWriter, r *http.Request) {
@@ -145,7 +145,7 @@ func TestCustomIPHeaderWithoutDefault(t *testing.T) {
 	w := httptest.NewRecorder()
 
 	r := chi.NewRouter()
-	r.Use(RealIPCustomHeader([]string{"X-CUSTOM-IP"}))
+	r.Use(RealIPFromHeaders([]string{"X-CUSTOM-IP"}))
 
 	realIP := ""
 	r.Get("/", func(w http.ResponseWriter, r *http.Request) {