QueryItemValue

public protocol QueryItemValue

A type that can be used as a value for a query item.

The QueryItemValue protocol defines a type that can be used as a value for a query item. It requires conforming types to provide a serializedQueryItem property that returns a string representation of the query item value.

Show on GitHub

  • The serialized value of the query item.

    This property represents the serialized value of the query item. It is used to convert the query item value into a string format suitable for URL query parameters.

    Declaration

    Swift

    var serializedQueryItem: String? { get }
    Show on GitHub

  • Indicates whether the query item is a collection.

    This property is used to determine if the query item is a collection.

    Declaration

    Swift

    var isCollection: Bool { get }
    Show on GitHub

  • Iterates over the elements of the collection.

    This method is used to iterate over the elements of the collection. If the query item is not a collection, this method should not be called.

    Declaration

    Swift

    func iterateCollection(_ iterator: (QueryItemValue) -> Void)

    Parameters

    iterator

    A closure that is called for each element in the collection.
    Show on GitHub

Available where Self: RawRepresentable, RawValue: QueryItemValue