is_string_validator.go

package validators

import (
	"errors"
	"fmt"
)

// Checks if the value is a string.
//
// Configuration parameters:
//
// 1. errorMessage (string): custom error message (optional).
//
// Input value (string): value to be validated.
//
// Usage examples:
//
//	value1 := "Name"
//	v.IsString()(value1)        // Output: nil, false
//
//	value2 := nil
//	v.IsString()(value2)        // Output: [error message], true
//
//	value3 := 0
//	v.IsString()(value3)        // Output: [error message], true
//	v.IsString("error")(value3) // Output: "error", true
func IsString(
	errorMessage ...string,
) Validator {
	message := ""
	if len(errorMessage) != 0 {
		message = errorMessage[0]
	}

	return func(value any) (error, bool) {
		if _, ok := value.(string); !ok {
			if message == "" {
				message = fmt.Sprintf(
					"The value is not a string: value is %T.",
					value,
				)
			}

			return errors.New(message), true
		}

		return nil, false
	}
}