params.go

package go_requests

// QueryParams is the interface for query params. It is used to add, set, get, delete and clone query params.
type QueryParams interface {
	// Add adds the key, value pair to the query params.
	// If the key already exists, the value will be appended to the existing values.
	Add(key, value string) QueryParams
	// Set sets the key, value pair to the query params.
	// If the key already exists, the value will be replaced with the new value.
	Set(key, value string) QueryParams
	// Get gets the first value associated with the given key.
	// If there are no values associated with the key, Get returns "".
	// To access multiple values, use the map directly.
	Get(key string) string
	// Del deletes the values associated with key.
	Del(key string) QueryParams
	// Values returns the values map.
	Values() map[string]string
	// Clone returns a copy of the QueryParams.
	Clone() QueryParams
	// Reset resets the QueryParams to the initial state.
	Reset() QueryParams
	// Len returns the number of query params.
	Len() int
}

// implementation of QueryParams
type queryParams struct {
	values map[string]string
	// contains filtered or unexported fields=
}

// Add adds the key, value pair to the query params.
func (q queryParams) Add(key, value string) QueryParams {
	// add the key, value pair to the query params.
	// If the key already exists, the value will be appended to the existing values. if not, create a new one
	q.values[key] = value
	return q
}

// Set sets the key, value pair to the query params.
func (q queryParams) Set(key, value string) QueryParams {
	// Set sets the key, value pair to the query params.
	// If the key already exists, the value will be replaced with the new value.
	q.values[key] = value
	return q
}

// Get gets the first value associated with the given key.
func (q queryParams) Get(key string) string {
	// Get gets the first value associated with the given key.
	// If there are no values associated with the key, Get returns "".
	// To access multiple values, use the map directly.
	if len(q.values[key]) > 0 {
		return q.values[key]
	}
	return ""
}

// Del deletes the values associated with key.
func (q queryParams) Del(key string) QueryParams {
	// Del deletes the values associated with key.
	delete(q.values, key)
	return q
}

// Values returns the values map.
func (q queryParams) Values() map[string]string {
	return q.values
}

// Clone returns a copy of the QueryParams.
func (q queryParams) Clone() QueryParams {
	//clone the queryParams
	clone := NewQueryParams()
	for key, values := range q.values {
		for _, value := range values {
			clone.Add(key, string(value))
		}
	}
	return clone
}

// Reset resets the QueryParams to the initial state.
func (q queryParams) Reset() QueryParams {
	q.values = make(map[string]string)
	return q
}

// Len returns the number of query params.
func (q queryParams) Len() int {
	return len(q.values)
}

// NewQueryParams returns a new QueryParams. It is used to add, set, get, delete and clone query params.
func NewQueryParams() QueryParams {
	return &queryParams{
		values: make(map[string]string),
	}
}