Update README.md

Author: kean

README.md

@@ -110,10 +110,13 @@ You can access the encoding results at any time, and they come in different form
 
 ```swift
 public final class URLQueryEncoder {
+    // Encoded query items.
     public var queryItems: [URLQueryItem]
+    // Encoded query items as name-value pairs.
     public var items: [(String, String?)]
-    
+    // The encoded query items as a URL query subcomponent.
     public var query: String?
+    // The encoded query items as a URL query subcomponent with percent-encoded values.
     public var percentEncodedQuery: String?
 }
 ```

Sources/URLQueryEncoder/URLQueryEncoder.swift

@@ -6,11 +6,11 @@ import Foundation
 
 public final class URLQueryEncoder {
     public var explode = true
-    public var delimeter = ","
+    public var delimiter = ","
     public var isDeepObject = false
 
     private var _explode = true
-    private var _delimeter = ","
+    private var _delimiter = ","
     private var _isDeepObject = false
 
     /// By default, `.iso8601`.
@@ -60,10 +60,10 @@ public final class URLQueryEncoder {
 
     public init() {}
 
-    public func encode(_ value: Encodable, explode: Bool? = nil, delimeter: String? = nil, isDeepObject: Bool? = nil) {
+    public func encode(_ value: Encodable, explode: Bool? = nil, delimiter: String? = nil, isDeepObject: Bool? = nil) {
         // Temporary override the settings to the duration of the call
         _explode = explode ?? self.explode
-        _delimeter = delimeter ?? self.delimeter
+        _delimiter = delimiter ?? self.delimiter
         _isDeepObject = isDeepObject ?? self.isDeepObject
 
         let encoder = _URLQueryEncoder(encoder: self)
@@ -202,7 +202,7 @@ private extension URLQueryEncoder {
                 }
             } else { // Encoding an array or a primitive value
                 if var queryItem = queryItems.last, queryItem.name == key {
-                    queryItem.value = [queryItem.value, value].compactMap { $0 }.joined(separator: _delimeter)
+                    queryItem.value = [queryItem.value, value].compactMap { $0 }.joined(separator: _delimiter)
                     queryItems[queryItems.endIndex - 1] = queryItem
                 } else {
                     queryItems.append(URLQueryItem(name: key, value: value))

Tests/URLQueryEncoderTests/URLQueryEncoderTests.swift

@@ -119,7 +119,7 @@ final class QueryEncoderTests: XCTestCase {
         // WHEN
         let encoder = URLQueryEncoder()
         encoder.explode = true
-        encoder.delimeter = " "
+        encoder.delimiter = " "
         encoder.encode(["id": ids])
 
         // THEN
@@ -133,21 +133,21 @@ final class QueryEncoderTests: XCTestCase {
         // WHEN
         let encoder = URLQueryEncoder()
         encoder.explode = false
-        encoder.delimeter = " "
+        encoder.delimiter = " "
         encoder.encode(["id": ids])
 
         // THEN
         XCTAssertEqual(encoder.query, "id=3 4 5")
         XCTAssertEqual(encoder.percentEncodedQuery, "id=3%204%205")
     }
 
-    func testStyleSpaceDelimitedExplodeFalsePassDelimeterDirectly() {
+    func testStyleSpaceDelimitedExplodeFalsePassDelimiterDirectly() {
         // GIVEN
         let ids = [3, 4, 5]
 
         // WHEN
         let encoder = URLQueryEncoder()
-        encoder.encode(["id": ids], explode: false, delimeter: " ")
+        encoder.encode(["id": ids], explode: false, delimiter: " ")
 
         // THEN
         XCTAssertEqual(encoder.query, "id=3 4 5")
@@ -166,7 +166,7 @@ final class QueryEncoderTests: XCTestCase {
         // WHEN
         let encoder = URLQueryEncoder()
         encoder.explode = true
-        encoder.delimeter = "|"
+        encoder.delimiter = "|"
         encoder.encode(["id": ids])
 
         // THEN
@@ -180,7 +180,7 @@ final class QueryEncoderTests: XCTestCase {
         // WHEN
         let encoder = URLQueryEncoder()
         encoder.explode = false
-        encoder.delimeter = "|"
+        encoder.delimiter = "|"
         encoder.encode(["id": ids])
 
         // THEN