From 316e3015a11b52807c657af998ab561b5d0c55eb Mon Sep 17 00:00:00 2001 From: David Jones Date: Fri, 20 Sep 2019 15:57:51 +0100 Subject: [PATCH] docs: Update documentation for #45 (#48) --- docs/Classes.html | 16 +- docs/Classes/Coder.html | 19 +- docs/Classes/QueryDecoder.html | 45 ++- docs/Classes/QueryEncoder.html | 55 +-- docs/Enums.html | 24 +- docs/Enums/IdentifierError.html | 19 +- docs/Enums/Operator.html | 73 ++-- docs/Enums/Order.html | 45 +-- docs/Enums/QueryParamsError.html | 19 +- docs/Extensions.html | 40 +- docs/Extensions/Bool.html | 19 +- docs/Extensions/DateError.html | 303 ++++++++++++++ docs/Extensions/Double.html | 19 +- docs/Extensions/Float.html | 19 +- docs/Extensions/Int.html | 19 +- docs/Extensions/Int16.html | 19 +- docs/Extensions/Int32.html | 19 +- docs/Extensions/Int64.html | 19 +- docs/Extensions/Int8.html | 19 +- docs/Extensions/String.html | 161 ++++++-- docs/Extensions/UInt.html | 19 +- docs/Extensions/UInt16.html | 19 +- docs/Extensions/UInt32.html | 19 +- docs/Extensions/UInt64.html | 19 +- docs/Extensions/UInt8.html | 19 +- docs/Protocols.html | 23 +- docs/Protocols/BodyDecoder.html | 19 +- docs/Protocols/BodyEncoder.html | 19 +- docs/Protocols/Identifier.html | 19 +- docs/Protocols/Operation.html | 19 +- docs/Protocols/QueryParams.html | 378 ++++++++++++++++++ docs/Structs.html | 34 +- docs/Structs/BodyFormat.html | 21 +- docs/Structs/ExclusiveRange.html | 21 +- docs/Structs/GreaterThan.html | 21 +- docs/Structs/GreaterThanOrEqual.html | 21 +- docs/Structs/InclusiveRange.html | 21 +- docs/Structs/LowerThan.html | 21 +- docs/Structs/LowerThanOrEqual.html | 21 +- docs/Structs/Ordering.html | 21 +- docs/Structs/Pagination.html | 19 +- docs/Structs/RequestError.html | 205 +++++----- docs/Structs/RequestError/ErrorBody.html | 27 +- docs/Structs/UnsupportedBodyFormatError.html | 17 +- docs/Typealiases.html | 20 +- docs/badge.svg | 16 +- docs/css/jazzy.css | 10 +- .../Contents/Resources/Documents/Classes.html | 16 +- .../Resources/Documents/Classes/Coder.html | 19 +- .../Documents/Classes/QueryDecoder.html | 45 ++- .../Documents/Classes/QueryEncoder.html | 55 +-- .../Contents/Resources/Documents/Enums.html | 24 +- .../Documents/Enums/IdentifierError.html | 19 +- .../Resources/Documents/Enums/Operator.html | 73 ++-- .../Resources/Documents/Enums/Order.html | 45 +-- .../Documents/Enums/QueryParamsError.html | 19 +- .../Resources/Documents/Extensions.html | 40 +- .../Resources/Documents/Extensions/Bool.html | 19 +- .../Documents/Extensions/DateError.html | 303 ++++++++++++++ .../Documents/Extensions/Double.html | 19 +- .../Resources/Documents/Extensions/Float.html | 19 +- .../Resources/Documents/Extensions/Int.html | 19 +- .../Resources/Documents/Extensions/Int16.html | 19 +- .../Resources/Documents/Extensions/Int32.html | 19 +- .../Resources/Documents/Extensions/Int64.html | 19 +- .../Resources/Documents/Extensions/Int8.html | 19 +- .../Documents/Extensions/String.html | 161 ++++++-- .../Resources/Documents/Extensions/UInt.html | 19 +- .../Documents/Extensions/UInt16.html | 19 +- .../Documents/Extensions/UInt32.html | 19 +- .../Documents/Extensions/UInt64.html | 19 +- .../Resources/Documents/Extensions/UInt8.html | 19 +- .../Resources/Documents/Protocols.html | 23 +- .../Documents/Protocols/BodyDecoder.html | 19 +- .../Documents/Protocols/BodyEncoder.html | 19 +- .../Documents/Protocols/Identifier.html | 19 +- .../Documents/Protocols/Operation.html | 19 +- .../Documents/Protocols/QueryParams.html | 378 ++++++++++++++++++ .../Contents/Resources/Documents/Structs.html | 34 +- .../Documents/Structs/BodyFormat.html | 21 +- .../Documents/Structs/ExclusiveRange.html | 21 +- .../Documents/Structs/GreaterThan.html | 21 +- .../Documents/Structs/GreaterThanOrEqual.html | 21 +- .../Documents/Structs/InclusiveRange.html | 21 +- .../Documents/Structs/LowerThan.html | 21 +- .../Documents/Structs/LowerThanOrEqual.html | 21 +- .../Resources/Documents/Structs/Ordering.html | 21 +- .../Documents/Structs/Pagination.html | 19 +- .../Documents/Structs/RequestError.html | 205 +++++----- .../Structs/RequestError/ErrorBody.html | 27 +- .../Structs/UnsupportedBodyFormatError.html | 17 +- .../Resources/Documents/Typealiases.html | 20 +- .../Resources/Documents/css/jazzy.css | 10 +- .../Contents/Resources/Documents/index.html | 11 +- .../Contents/Resources/Documents/js/jazzy.js | 6 - .../Resources/Documents/js/jazzy.search.js | 26 +- .../Resources/Documents/js/jquery.min.js | 6 +- .../Resources/Documents/js/lunr.min.js | 7 +- .../Documents/js/typeahead.jquery.js | 228 ++++++++--- .../Contents/Resources/Documents/search.json | 2 +- .../Contents/Resources/docSet.dsidx | Bin 73728 -> 77824 bytes docs/docsets/KituraContracts.tgz | Bin 131390 -> 140993 bytes docs/index.html | 11 +- docs/js/jazzy.js | 6 - docs/js/jazzy.search.js | 26 +- docs/js/jquery.min.js | 6 +- docs/js/lunr.min.js | 7 +- docs/js/typeahead.jquery.js | 228 ++++++++--- docs/search.json | 2 +- docs/undocumented.json | 8 +- 110 files changed, 3361 insertions(+), 1321 deletions(-) create mode 100644 docs/Extensions/DateError.html create mode 100644 docs/Protocols/QueryParams.html create mode 100644 docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/DateError.html create mode 100644 docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols/QueryParams.html mode change 100755 => 100644 docs/docsets/KituraContracts.docset/Contents/Resources/Documents/js/lunr.min.js mode change 100755 => 100644 docs/js/lunr.min.js diff --git a/docs/Classes.html b/docs/Classes.html index 465411d..b928b00 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -14,6 +14,7 @@ + @@ -22,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

@@ -86,6 +87,9 @@

+ @@ -143,7 +147,7 @@ Operation @@ -326,7 +330,7 @@

Decoding Empty Values:

Declaration

Swift

-
public class QueryDecoder: Coder, Decoder, BodyDecoder
+
public class QueryDecoder : Coder, Decoder, BodyDecoder
@@ -369,7 +373,7 @@

Usage Example:

Declaration

Swift

-
public class QueryEncoder: Coder, Encoder, BodyEncoder
+
public class QueryEncoder : Coder, Encoder, BodyEncoder
@@ -384,8 +388,8 @@

Declaration

diff --git a/docs/Classes/Coder.html b/docs/Classes/Coder.html index 3883943..7109264 100644 --- a/docs/Classes/Coder.html +++ b/docs/Classes/Coder.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

@@ -87,6 +87,9 @@

+ @@ -144,7 +147,7 @@ Operation @@ -264,9 +267,9 @@

Usage Example:

  • - + - dateFormatter + dateFormatter
    @@ -322,9 +325,9 @@

    Declaration

  • - + - getFieldName(from:) + getFieldName(from:)
    @@ -357,8 +360,8 @@

    Declaration

    diff --git a/docs/Classes/QueryDecoder.html b/docs/Classes/QueryDecoder.html index 36d299f..43d5ce6 100644 --- a/docs/Classes/QueryDecoder.html +++ b/docs/Classes/QueryDecoder.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    QueryDecoder

    -
    public class QueryDecoder: Coder, Decoder, BodyDecoder
    +
    public class QueryDecoder : Coder, Decoder, BodyDecoder
    @@ -300,7 +303,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public var codingPath: [CodingKey] = []
    +
    public var codingPath: [CodingKey]
    @@ -310,9 +313,9 @@

    Declaration

  • - + - userInfo + userInfo
    @@ -327,7 +330,7 @@

    Declaration

    Declaration

    Swift

    -
    public var userInfo: [CodingUserInfoKey : Any] = [:]
    +
    public var userInfo: [CodingUserInfoKey : Any]
    @@ -337,9 +340,9 @@

    Declaration

  • - + - dictionary + dictionary
    @@ -391,9 +394,9 @@

    Declaration

  • - + - init(dictionary:) + init(dictionary:)
    @@ -418,9 +421,9 @@

    Declaration

  • - + - decode(_:from:) + decode(_:from:)
    @@ -441,7 +444,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public func decode<T: Decodable>(_ type: T.Type, from data: Data) throws -> T
    +
    public func decode<T>(_ type: T.Type, from data: Data) throws -> T where T : Decodable
    @@ -482,9 +485,9 @@

    Parameters

  • - + - decode(_:) + decode(_:)
    @@ -505,7 +508,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public func decode<T: Decodable>(_ type: T.Type) throws -> T
    +
    public func decode<T>(_ type: T.Type) throws -> T where T : Decodable
    @@ -534,9 +537,9 @@

    Parameters

  • - + - container(keyedBy:) + container(keyedBy:)
    @@ -629,8 +632,8 @@

    Declaration

    diff --git a/docs/Classes/QueryEncoder.html b/docs/Classes/QueryEncoder.html index eeeeb60..4df2b39 100644 --- a/docs/Classes/QueryEncoder.html +++ b/docs/Classes/QueryEncoder.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    QueryEncoder

    -
    public class QueryEncoder: Coder, Encoder, BodyEncoder
    +
    public class QueryEncoder : Coder, Encoder, BodyEncoder
    @@ -292,7 +295,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public var codingPath: [CodingKey] = []
    +
    public var codingPath: [CodingKey]
    @@ -302,9 +305,9 @@

    Declaration

  • - + - userInfo + userInfo
    @@ -319,7 +322,7 @@

    Declaration

    Declaration

    Swift

    -
    public var userInfo: [CodingUserInfoKey: Any] = [:]
    +
    public var userInfo: [CodingUserInfoKey : Any]
    @@ -356,9 +359,9 @@

    Declaration

  • - + - encode(_:) + encode(_:)
    @@ -379,7 +382,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public func encode<T: Encodable>(_ value: T) throws -> String
    +
    public func encode<T>(_ value: T) throws -> String where T : Encodable
    @@ -408,9 +411,9 @@

    Parameters

  • - + - encode(_:) + encode(_:)
    @@ -431,7 +434,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public func encode<T : Encodable>(_ value: T) throws -> Data
    +
    public func encode<T>(_ value: T) throws -> Data where T : Encodable
    @@ -460,9 +463,9 @@

    Parameters

  • - + - encode(_:) + encode(_:)
    @@ -483,7 +486,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public func encode<T: Encodable>(_ value: T) throws -> [URLQueryItem]
    +
    public func encode<T>(_ value: T) throws -> [URLQueryItem] where T : Encodable
    @@ -512,9 +515,9 @@

    Parameters

  • - + - encode(_:) + encode(_:)
    @@ -535,7 +538,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public func encode<T: Encodable>(_ value: T) throws -> [String : String]
    +
    public func encode<T>(_ value: T) throws -> [String : String] where T : Encodable
    @@ -564,9 +567,9 @@

    Parameters

  • - + - encode(_:) + encode(_:)
    @@ -581,7 +584,7 @@

    Parameters

    Declaration

    Swift

    -
    public func encode<T: Encodable>(_ value: T) throws -> [String : Any]
    +
    public func encode<T>(_ value: T) throws -> [String : Any] where T : Encodable
    @@ -591,9 +594,9 @@

    Declaration

  • - + - container(keyedBy:) + container(keyedBy:)
    @@ -686,8 +689,8 @@

    Declaration

    diff --git a/docs/Enums.html b/docs/Enums.html index bf970a1..0002119 100644 --- a/docs/Enums.html +++ b/docs/Enums.html @@ -14,6 +14,7 @@ + @@ -22,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -86,6 +87,9 @@

  • + @@ -143,7 +147,7 @@ Operation @@ -267,7 +271,7 @@

    Enumerations

    An error representing a failure to create an Identifier.

    Usage Example:

    -

    An QueryParamsError.invalidValue may be thrown if the given type cannot be constructed from the given string.

    +

    An QueryParamsError.invalidValue may be thrown if the given type cannot be constructed from the given string.

     throw QueryParamsError.invalidValue
     
    @@ -277,7 +281,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public enum QueryParamsError: Error
    +
    public enum QueryParamsError : Error
    @@ -300,7 +304,7 @@

    Declaration

    An error representing a failure to create an Identifier.

    Usage Example:

    -

    An IdentifierError.invalidValue may be thrown if the given string cannot be converted to an integer when using an Identifier.

    +

    An IdentifierError.invalidValue may be thrown if the given string cannot be converted to an integer when using an Identifier.

     throw IdentifierError.invalidValue
     
    @@ -310,7 +314,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public enum IdentifierError: Error
    +
    public enum IdentifierError : Error
    @@ -343,7 +347,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public enum Order: Codable
    +
    public enum Order : Codable
    @@ -376,7 +380,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public enum Operator: String, Codable
    +
    public enum Operator : String, Codable
    @@ -391,8 +395,8 @@

    Declaration

    diff --git a/docs/Enums/IdentifierError.html b/docs/Enums/IdentifierError.html index 262490a..e5e9227 100644 --- a/docs/Enums/IdentifierError.html +++ b/docs/Enums/IdentifierError.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

    + @@ -144,7 +147,7 @@ Operation @@ -245,14 +248,14 @@

    IdentifierError

    -
    public enum IdentifierError: Error
    +
    public enum IdentifierError : Error

    An error representing a failure to create an Identifier.

    Usage Example:

    -

    An IdentifierError.invalidValue may be thrown if the given string cannot be converted to an integer when using an Identifier.

    +

    An IdentifierError.invalidValue may be thrown if the given string cannot be converted to an integer when using an Identifier.

     throw IdentifierError.invalidValue
     
    @@ -266,9 +269,9 @@

    Usage Example:

  • - + - invalidValue + invalidValue
    @@ -298,8 +301,8 @@

    Declaration

    diff --git a/docs/Enums/Operator.html b/docs/Enums/Operator.html index b36b455..586982c 100644 --- a/docs/Enums/Operator.html +++ b/docs/Enums/Operator.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    Operator

    -
    public enum Operator: String, Codable
    +
    public enum Operator : String, Codable
    @@ -266,9 +269,9 @@

    Usage Example:

  • - + - or + or
    @@ -290,16 +293,12 @@

    Declaration

  • - - -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    -
    diff --git a/docs/Enums/Order.html b/docs/Enums/Order.html index 8427c0d..7504aa8 100644 --- a/docs/Enums/Order.html +++ b/docs/Enums/Order.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

    + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    Order

    -
    public enum Order: Codable
    +
    public enum Order : Codable
    @@ -266,9 +269,9 @@

    Usage Example:

  • - - - asc + + + asc(_:)
    @@ -290,16 +293,12 @@

    Declaration

  • - - -
    - -
    -
    -
    @@ -439,8 +434,8 @@

    Declaration

    diff --git a/docs/Enums/QueryParamsError.html b/docs/Enums/QueryParamsError.html index 73035a9..f5163a1 100644 --- a/docs/Enums/QueryParamsError.html +++ b/docs/Enums/QueryParamsError.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

    + @@ -144,7 +147,7 @@ Operation @@ -245,14 +248,14 @@

    QueryParamsError

    -
    public enum QueryParamsError: Error
    +
    public enum QueryParamsError : Error

    An error representing a failure to create an Identifier.

    Usage Example:

    -

    An QueryParamsError.invalidValue may be thrown if the given type cannot be constructed from the given string.

    +

    An QueryParamsError.invalidValue may be thrown if the given type cannot be constructed from the given string.

     throw QueryParamsError.invalidValue
     
    @@ -266,9 +269,9 @@

    Usage Example:

  • - + - invalidValue + invalidValue
    @@ -298,8 +301,8 @@

    Declaration

    diff --git a/docs/Extensions.html b/docs/Extensions.html index dab8984..2b40e99 100644 --- a/docs/Extensions.html +++ b/docs/Extensions.html @@ -14,6 +14,7 @@ + @@ -22,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -86,6 +87,9 @@

  • + @@ -143,7 +147,7 @@ Operation @@ -279,6 +283,34 @@

    Declaration

    +
  • +
    + + + + DateError + +
    +
    +
    +
    +
    +
    +

    Undocumented

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    enum DateError : Error
    + +
    +
    +
    +
    +
  • @@ -692,8 +724,8 @@

    Declaration

    diff --git a/docs/Extensions/Bool.html b/docs/Extensions/Bool.html index 578215b..5c13511 100644 --- a/docs/Extensions/Bool.html +++ b/docs/Extensions/Bool.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

    + @@ -144,7 +147,7 @@ Operation @@ -260,9 +263,9 @@

    Bool

  • - + - init(value:) + init(value:)
    @@ -273,7 +276,7 @@

    Bool

    Creates a bool identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to a Bool. + An IdentifierError.invalidValue if the given string cannot be converted to a Bool.
    @@ -309,7 +312,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -324,8 +327,8 @@

    Declaration

    diff --git a/docs/Extensions/DateError.html b/docs/Extensions/DateError.html new file mode 100644 index 0000000..7657a0e --- /dev/null +++ b/docs/Extensions/DateError.html @@ -0,0 +1,303 @@ + + + + DateError Extension Reference + + + + + + + + + + + + + + + + +
    +

    + + KituraContracts Docs + + (99% documented) +

    + +

    +

    + +
    +

    + +

    + + + View on GitHub + +

    + +
    + + + +
    + +
    + +
    +
    +

    DateError

    +
    +
    +
    enum DateError : Error
    + +
    +
    +

    Undocumented

    + +
    +
    + +
    +
    +
    +
      +
    • +
      + + + + errorDescription + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public var errorDescription: String? { get }
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + + + diff --git a/docs/Extensions/Double.html b/docs/Extensions/Double.html index 7f4d728..1886abc 100644 --- a/docs/Extensions/Double.html +++ b/docs/Extensions/Double.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -260,9 +263,9 @@

    Double

  • - + - init(value:) + init(value:)
    @@ -273,7 +276,7 @@

    Double

    Creates a double identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to a Double. + An IdentifierError.invalidValue if the given string cannot be converted to a Double.
    @@ -309,7 +312,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -324,8 +327,8 @@

    Declaration

    diff --git a/docs/Extensions/Float.html b/docs/Extensions/Float.html index 35304ef..0f2942d 100644 --- a/docs/Extensions/Float.html +++ b/docs/Extensions/Float.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -260,9 +263,9 @@

    Float

  • - + - init(value:) + init(value:)
    @@ -273,7 +276,7 @@

    Float

    Creates a float identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to a Float. + An IdentifierError.invalidValue if the given string cannot be converted to a Float.
    @@ -309,7 +312,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -324,8 +327,8 @@

    Declaration

    diff --git a/docs/Extensions/Int.html b/docs/Extensions/Int.html index 7014b6a..c3cf07d 100644 --- a/docs/Extensions/Int.html +++ b/docs/Extensions/Int.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -278,7 +281,7 @@

    Usage Example:

    Creates an integer identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to an integer. + An IdentifierError.invalidValue if the given string cannot be converted to an integer.
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/Extensions/Int16.html b/docs/Extensions/Int16.html index 2a2d0ab..077e7cf 100644 --- a/docs/Extensions/Int16.html +++ b/docs/Extensions/Int16.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -278,7 +281,7 @@

    Usage Example:

    Creates an integer identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to an integer. + An IdentifierError.invalidValue if the given string cannot be converted to an integer.
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/Extensions/Int32.html b/docs/Extensions/Int32.html index 5c5e564..611b239 100644 --- a/docs/Extensions/Int32.html +++ b/docs/Extensions/Int32.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -278,7 +281,7 @@

    Usage Example:

    Creates an integer identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to an integer. + An IdentifierError.invalidValue if the given string cannot be converted to an integer.
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/Extensions/Int64.html b/docs/Extensions/Int64.html index 44118ca..3a9d13c 100644 --- a/docs/Extensions/Int64.html +++ b/docs/Extensions/Int64.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -278,7 +281,7 @@

    Usage Example:

    Creates an integer identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to an integer. + An IdentifierError.invalidValue if the given string cannot be converted to an integer.
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/Extensions/Int8.html b/docs/Extensions/Int8.html index 0555ee5..8db56b0 100644 --- a/docs/Extensions/Int8.html +++ b/docs/Extensions/Int8.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -278,7 +281,7 @@

    Usage Example:

    Creates an integer identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to an integer. + An IdentifierError.invalidValue if the given string cannot be converted to an integer.
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/Extensions/String.html b/docs/Extensions/String.html index 17506c7..8a5c788 100644 --- a/docs/Extensions/String.html +++ b/docs/Extensions/String.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -278,7 +281,7 @@

    String

    Declaration

    Swift

    -
    public var int: Int?
    +
    public var int: Int? { get }
    @@ -305,7 +308,7 @@

    Declaration

    Declaration

    Swift

    -
    public var int8: Int8?
    +
    public var int8: Int8? { get }
    @@ -332,7 +335,7 @@

    Declaration

    Declaration

    Swift

    -
    public var int16: Int16?
    +
    public var int16: Int16? { get }
    @@ -359,7 +362,7 @@

    Declaration

    Declaration

    Swift

    -
    public var int32: Int32?
    +
    public var int32: Int32? { get }
    @@ -386,7 +389,7 @@

    Declaration

    Declaration

    Swift

    -
    public var int64: Int64?
    +
    public var int64: Int64? { get }
    @@ -413,7 +416,7 @@

    Declaration

    Declaration

    Swift

    -
    public var uInt: UInt?
    +
    public var uInt: UInt? { get }
    @@ -440,7 +443,7 @@

    Declaration

    Declaration

    Swift

    -
    public var uInt8: UInt8?
    +
    public var uInt8: UInt8? { get }
    @@ -467,7 +470,7 @@

    Declaration

    Declaration

    Swift

    -
    public var uInt16: UInt16?
    +
    public var uInt16: UInt16? { get }
    @@ -494,7 +497,7 @@

    Declaration

    Declaration

    Swift

    -
    public var uInt32: UInt32?
    +
    public var uInt32: UInt32? { get }
    @@ -521,7 +524,7 @@

    Declaration

    Declaration

    Swift

    -
    public var uInt64: UInt64?
    +
    public var uInt64: UInt64? { get }
    @@ -548,7 +551,7 @@

    Declaration

    Declaration

    Swift

    -
    public var float: Float?
    +
    public var float: Float? { get }
    @@ -575,7 +578,7 @@

    Declaration

    Declaration

    Swift

    -
    public var double: Double?
    +
    public var double: Double? { get }
    @@ -602,7 +605,7 @@

    Declaration

    Declaration

    Swift

    -
    public var boolean: Bool?
    +
    public var boolean: Bool? { get }
    @@ -629,7 +632,7 @@

    Declaration

    Declaration

    Swift

    -
    public var string: String
    +
    public var string: String { get }
    @@ -656,7 +659,7 @@

    Declaration

    Declaration

    Swift

    -
    public var intArray: [Int]?
    +
    public var intArray: [Int]? { get }
    @@ -683,7 +686,7 @@

    Declaration

    Declaration

    Swift

    -
    public var int8Array: [Int8]?
    +
    public var int8Array: [Int8]? { get }
    @@ -710,7 +713,7 @@

    Declaration

    Declaration

    Swift

    -
    public var int16Array: [Int16]?
    +
    public var int16Array: [Int16]? { get }
    @@ -737,7 +740,7 @@

    Declaration

    Declaration

    Swift

    -
    public var int32Array: [Int32]?
    +
    public var int32Array: [Int32]? { get }
    @@ -764,7 +767,7 @@

    Declaration

    Declaration

    Swift

    -
    public var int64Array: [Int64]?
    +
    public var int64Array: [Int64]? { get }
    @@ -791,7 +794,7 @@

    Declaration

    Declaration

    Swift

    -
    public var uIntArray: [UInt]?
    +
    public var uIntArray: [UInt]? { get }
    @@ -818,7 +821,7 @@

    Declaration

    Declaration

    Swift

    -
    public var uInt8Array: [UInt8]?
    +
    public var uInt8Array: [UInt8]? { get }
    @@ -845,7 +848,7 @@

    Declaration

    Declaration

    Swift

    -
    public var uInt16Array: [UInt16]?
    +
    public var uInt16Array: [UInt16]? { get }
    @@ -872,7 +875,7 @@

    Declaration

    Declaration

    Swift

    -
    public var uInt32Array: [UInt32]?
    +
    public var uInt32Array: [UInt32]? { get }
    @@ -899,7 +902,7 @@

    Declaration

    Declaration

    Swift

    -
    public var uInt64Array: [UInt64]?
    +
    public var uInt64Array: [UInt64]? { get }
    @@ -926,7 +929,7 @@

    Declaration

    Declaration

    Swift

    -
    public var floatArray: [Float]?
    +
    public var floatArray: [Float]? { get }
    @@ -953,7 +956,7 @@

    Declaration

    Declaration

    Swift

    -
    public var doubleArray: [Double]?
    +
    public var doubleArray: [Double]? { get }
    @@ -980,7 +983,7 @@

    Declaration

    Declaration

    Swift

    -
    public var booleanArray: [Bool]?
    +
    public var booleanArray: [Bool]? { get }
    @@ -1007,7 +1010,7 @@

    Declaration

    Declaration

    Swift

    -
    public var stringArray: [String]
    +
    public var stringArray: [String] { get }
    @@ -1017,9 +1020,9 @@

    Declaration

  • - + - decodable(_:) + decodable(_:)
    @@ -1034,7 +1037,7 @@

    Declaration

    Declaration

    Swift

    -
    public func decodable<T: Decodable>(_ type: T.Type) -> T?
    +
    public func decodable<T>(_ type: T.Type) -> T? where T : Decodable
    @@ -1067,9 +1070,9 @@

    Return Value

  • - + - date(_:) + date(_:)
    @@ -1117,9 +1120,9 @@

    Return Value

  • - + - dateArray(_:) + dateArray(_:)
    @@ -1164,6 +1167,80 @@

    Return Value

  • +
  • +
    + + + + dateArray(decoderStrategy:decoder:) + +
    +
    +
    +
    +
    +
    +

    Converts the given String to a [Date]? object using the dateDecodingStrategy supplied.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func dateArray(decoderStrategy: JSONDecoder.DateDecodingStrategy = .formatted(Coder().dateFormatter), decoder: Decoder? = nil) -> [Date]?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + formatter + + +
    +

    The designated DateFormatter to convert the string with.

    +
    +
    + + decoderStrategy + + +
    +

    The JSON.dateDecodingStrategy that should be used to decode the specifed Date. Default is set to .formatted with default dateFormatter.

    +
    +
    + + decoder + + +
    +

    The Decoder parameter is only used for the custom strategy.

    +
    +
    +
    +
    +

    Return Value

    +

    The [Date]? object. Some on success / nil on failure.

    +
    +
    +
    +
  • @@ -1171,9 +1248,9 @@

    Return Value

  • - + - init(value:) + init(value:)
    @@ -1215,7 +1292,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -1230,8 +1307,8 @@

    Declaration

  • diff --git a/docs/Extensions/UInt.html b/docs/Extensions/UInt.html index b543078..13c7da1 100644 --- a/docs/Extensions/UInt.html +++ b/docs/Extensions/UInt.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

    + @@ -144,7 +147,7 @@ Operation @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -278,7 +281,7 @@

    Usage Example:

    Creates an unsigned integer identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to an unsigned integer. + An IdentifierError.invalidValue if the given string cannot be converted to an unsigned integer.
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/Extensions/UInt16.html b/docs/Extensions/UInt16.html index 69b8a67..a588cf4 100644 --- a/docs/Extensions/UInt16.html +++ b/docs/Extensions/UInt16.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -278,7 +281,7 @@

    Usage Example:

    Creates an unsigned integer identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to an unsigned integer. + An IdentifierError.invalidValue if the given string cannot be converted to an unsigned integer.
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/Extensions/UInt32.html b/docs/Extensions/UInt32.html index 78b1c55..67c6efe 100644 --- a/docs/Extensions/UInt32.html +++ b/docs/Extensions/UInt32.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -278,7 +281,7 @@

    Usage Example:

    Creates an unsigned integer identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to an unsigned integer. + An IdentifierError.invalidValue if the given string cannot be converted to an unsigned integer.
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/Extensions/UInt64.html b/docs/Extensions/UInt64.html index 847c9d3..a11ddd5 100644 --- a/docs/Extensions/UInt64.html +++ b/docs/Extensions/UInt64.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -278,7 +281,7 @@

    Usage Example:

    Creates an unsigned integer identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to an unsigned integer. + An IdentifierError.invalidValue if the given string cannot be converted to an unsigned integer.
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/Extensions/UInt8.html b/docs/Extensions/UInt8.html index 972d82b..f41c254 100644 --- a/docs/Extensions/UInt8.html +++ b/docs/Extensions/UInt8.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -278,7 +281,7 @@

    Usage Example:

    Creates an unsigned integer identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to an unsigned integer. + An IdentifierError.invalidValue if the given string cannot be converted to an unsigned integer.
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/Protocols.html b/docs/Protocols.html index af2873d..92b4687 100644 --- a/docs/Protocols.html +++ b/docs/Protocols.html @@ -14,6 +14,7 @@ + @@ -22,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -86,6 +87,9 @@

  • + @@ -143,7 +147,7 @@ Operation @@ -273,7 +277,7 @@

    Protocols

    Declaration

    Swift

    -
    public protocol BodyDecoder: AnyObject
    +
    public protocol BodyDecoder : AnyObject
    @@ -306,7 +310,7 @@

    Declaration

    Declaration

    Swift

    -
    public protocol BodyEncoder: AnyObject
    +
    public protocol BodyEncoder : AnyObject
    @@ -355,12 +359,13 @@

    Decoding Empty Values:

  • All other non-optional types throw a decoding error
  • + See more

    Declaration

    Swift

    -
    public protocol QueryParams: Codable
    +
    public protocol QueryParams : Decodable, Encodable
    @@ -392,7 +397,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public protocol Identifier: Codable
    +
    public protocol Identifier : Decodable, Encodable
    @@ -420,7 +425,7 @@

    Declaration

    Declaration

    Swift

    -
    public protocol Operation: Codable
    +
    public protocol Operation : Decodable, Encodable
    @@ -435,8 +440,8 @@

    Declaration

    diff --git a/docs/Protocols/BodyDecoder.html b/docs/Protocols/BodyDecoder.html index 7210609..25a40f8 100644 --- a/docs/Protocols/BodyDecoder.html +++ b/docs/Protocols/BodyDecoder.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

    + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    BodyDecoder

    -
    public protocol BodyDecoder: AnyObject
    +
    public protocol BodyDecoder : AnyObject
    @@ -262,9 +265,9 @@

    BodyDecoder

  • - + - decode(_:from:) + decode(_:from:)
    @@ -279,7 +282,7 @@

    BodyDecoder

    Declaration

    Swift

    -
    func decode<T : Decodable>(_ type: T.Type, from data: Data) throws -> T
    +
    func decode<T>(_ type: T.Type, from data: Data) throws -> T where T : Decodable
    @@ -294,8 +297,8 @@

    Declaration

    diff --git a/docs/Protocols/BodyEncoder.html b/docs/Protocols/BodyEncoder.html index cc566b4..3a0fd47 100644 --- a/docs/Protocols/BodyEncoder.html +++ b/docs/Protocols/BodyEncoder.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    BodyEncoder

    -
    public protocol BodyEncoder: AnyObject
    +
    public protocol BodyEncoder : AnyObject
    @@ -262,9 +265,9 @@

    BodyEncoder

  • - + - encode(_:) + encode(_:)
    @@ -279,7 +282,7 @@

    BodyEncoder

    Declaration

    Swift

    -
    func encode<T : Encodable>(_ value: T) throws -> Data
    +
    func encode<T>(_ value: T) throws -> Data where T : Encodable
    @@ -294,8 +297,8 @@

    Declaration

    diff --git a/docs/Protocols/Identifier.html b/docs/Protocols/Identifier.html index 270eae9..578ecdf 100644 --- a/docs/Protocols/Identifier.html +++ b/docs/Protocols/Identifier.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    Identifier

    -
    public protocol Identifier: Codable
    +
    public protocol Identifier : Decodable, Encodable
    @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    var value: String
    +
    var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/Protocols/Operation.html b/docs/Protocols/Operation.html index 910218a..e872043 100644 --- a/docs/Protocols/Operation.html +++ b/docs/Protocols/Operation.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    Operation

    -
    public protocol Operation: Codable
    +
    public protocol Operation : Decodable, Encodable
    @@ -261,9 +264,9 @@

    Operation

  • - + - init(string:) + init(string:)
    @@ -337,7 +340,7 @@

    Declaration

    Returns the Operator associated with the Operation.

    -

    InclusiveRange(start: 5, end: 10) will have the operator Operator.inclusiveRange

    +

    InclusiveRange(start: 5, end: 10) will have the operator Operator.inclusiveRange

    @@ -359,8 +362,8 @@

    Declaration

    diff --git a/docs/Protocols/QueryParams.html b/docs/Protocols/QueryParams.html new file mode 100644 index 0000000..7789bdb --- /dev/null +++ b/docs/Protocols/QueryParams.html @@ -0,0 +1,378 @@ + + + + QueryParams Protocol Reference + + + + + + + + + + + + + + + + +
    +

    + + KituraContracts Docs + + (99% documented) +

    + +

    +

    + +
    +

    + +

    + + + View on GitHub + +

    + +
    + + + +
    + +
    + +
    +
    +

    QueryParams

    +
    +
    +
    public protocol QueryParams : Decodable, Encodable
    + +
    +
    +

    An object that conforms to QueryParams is identified as being decodable from URLEncoded data. +This can be applied to a Codable route to define the names and types of the expected query parameters, and provide type-safe access to their values. The QueryDecoder is used to decode the URL encoded parameters into an instance of the conforming type.

    +

    Usage Example:

    +
    struct Query: QueryParams {
    +   let id: Int
    +}
    +router.get("/user") { (query: Query, respondWith: (User?, RequestError?) -> Void) in
    +    guard let user: User = userArray[query.id] else {
    +       return respondWith(nil, .notFound)
    +    }
    +    respondWith(user, nil)
    +}
    +
    +

    Decoding Empty Values:

    + +

    When an HTML form is sent with an empty or unchecked field, the corresponding key/value pair is sent with an empty value (i.e. &key1=&key2=). +The corresponding mapping to Swift types performed by QueryDecoder is as follows:

    + +
      +
    • Any Optional type (including String?) defaults to nil
    • +
    • Non-optional String successfully decodes to ""
    • +
    • Non-optional Bool decodes to false
    • +
    • All other non-optional types throw a decoding error
    • +
    + +
    +
    + +
    +
    +
    +
      +
    • +
      + + + + dateDecodingStrategy + +
      +
      +
      +
      +
      +
      +

      The decoding strategy for Dates. +The variable can be defined within your QueryParams object and tells the QueryDecoder how dates should be decoded. The enum used for the DateDecodingStrategy is the same one found in the JSONDecoder.

      +

      Usage Example:

      +
      struct MyQuery: QueryParams {
      +   let date: Date
      +   static let dateDecodingStrategy: JSONDecoder.DateDecodingStrategy = .iso8601
      +   static let dateEncodingStrategy: JSONEncoder.DateEncodingStrategy = .iso8601
      +}
      +
      +let queryParams = ["date": "2019-09-06T10:14:41+0000"]
      +
      +let query = try QueryDecoder(dictionary: queryParams).decode(MyQuery.self)
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      static var dateDecodingStrategy: JSONDecoder.DateDecodingStrategy { get }
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + dateEncodingStrategy + +
      +
      +
      +
      +
      +
      +

      The encoding strategy for Dates. + The variable would be defined within your QueryParams object and tells the QueryEncoder how dates should be encoded. The enum used for the DateEncodingStrategy is the same one found in the JSONEncoder. + ### Usage Example: ###

      +
       struct MyQuery: QueryParams {
      +    let date: Date
      +    static let dateDecodingStrategy: JSONDecoder.DateDecodingStrategy = .iso8601
      +    static let dateEncodingStrategy: JSONEncoder.DateEncodingStrategy = .iso8601
      + }
      +
      +let query = MyQuery(date: Date(timeIntervalSinceNow: 0))
      +
      +let myQueryDict: [String: String] = try QueryEncoder().encode(query)
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      static var dateEncodingStrategy: JSONEncoder.DateEncodingStrategy { get }
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + + + diff --git a/docs/Structs.html b/docs/Structs.html index 0ffcad6..2c81b9b 100644 --- a/docs/Structs.html +++ b/docs/Structs.html @@ -14,6 +14,7 @@ + @@ -22,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -86,6 +87,9 @@

  • + @@ -143,7 +147,7 @@ Operation @@ -290,7 +294,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public struct BodyFormat: Equatable
    +
    public struct BodyFormat : Equatable
    @@ -319,7 +323,7 @@

    Declaration

    Declaration

    Swift

    -
    public struct UnsupportedBodyFormatError: Error
    +
    public struct UnsupportedBodyFormatError : Error
    @@ -363,7 +367,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public struct RequestError: RawRepresentable, Equatable, Hashable, Comparable, Error, CustomStringConvertible
    +
    public struct RequestError : RawRepresentable, Equatable, Hashable, Comparable, Error, CustomStringConvertible
    @@ -396,7 +400,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public struct Ordering: Codable
    +
    public struct Ordering : Codable
    @@ -433,7 +437,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public struct Pagination: Codable
    +
    public struct Pagination : Codable
    @@ -475,7 +479,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public struct GreaterThan<I: Identifier>: Operation
    +
    public struct GreaterThan<I> : Operation where I : Identifier
    @@ -517,7 +521,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public struct GreaterThanOrEqual<I: Identifier>: Operation
    +
    public struct GreaterThanOrEqual<I> : Operation where I : Identifier
    @@ -560,7 +564,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public struct LowerThan<I: Identifier>: Operation
    +
    public struct LowerThan<I> : Operation where I : Identifier
    @@ -602,7 +606,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public struct LowerThanOrEqual<I: Identifier>: Operation
    +
    public struct LowerThanOrEqual<I> : Operation where I : Identifier
    @@ -644,7 +648,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public struct InclusiveRange<I: Identifier>: Operation
    +
    public struct InclusiveRange<I> : Operation where I : Identifier
    @@ -686,7 +690,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public struct ExclusiveRange<I: Identifier>: Operation
    +
    public struct ExclusiveRange<I> : Operation where I : Identifier
    @@ -701,8 +705,8 @@

    Declaration

    diff --git a/docs/Structs/BodyFormat.html b/docs/Structs/BodyFormat.html index 46c3d29..015ce9c 100644 --- a/docs/Structs/BodyFormat.html +++ b/docs/Structs/BodyFormat.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

    + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    BodyFormat

    -
    public struct BodyFormat: Equatable
    +
    public struct BodyFormat : Equatable
    @@ -306,9 +309,9 @@

    Declaration

  • - + - ==(_:_:) + ==(_:_:)
    @@ -323,7 +326,7 @@

    Declaration

    Declaration

    Swift

    -
    public static func == (_ lhs: BodyFormat, _ rhs: BodyFormat) -> Bool
    +
    public static func == (lhs: BodyFormat, rhs: BodyFormat) -> Bool
    @@ -350,7 +353,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let json = BodyFormat("application/json")
    +
    public static let json: BodyFormat
    @@ -365,8 +368,8 @@

    Declaration

    diff --git a/docs/Structs/ExclusiveRange.html b/docs/Structs/ExclusiveRange.html index 9285f94..5062686 100644 --- a/docs/Structs/ExclusiveRange.html +++ b/docs/Structs/ExclusiveRange.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    ExclusiveRange

    -
    public struct ExclusiveRange<I: Identifier>: Operation
    +
    public struct ExclusiveRange<I> : Operation where I : Identifier
    @@ -275,9 +278,9 @@

    Usage Example:

  • - + - init(start:end:) + init(start:end:)
    @@ -302,9 +305,9 @@

    Declaration

  • - + - init(string:) + init(string:)
    @@ -415,8 +418,8 @@

    Declaration

    diff --git a/docs/Structs/GreaterThan.html b/docs/Structs/GreaterThan.html index 6669d8b..6dbc450 100644 --- a/docs/Structs/GreaterThan.html +++ b/docs/Structs/GreaterThan.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    GreaterThan

    -
    public struct GreaterThan<I: Identifier>: Operation
    +
    public struct GreaterThan<I> : Operation where I : Identifier
    @@ -275,9 +278,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -302,9 +305,9 @@

    Declaration

  • - + - init(string:) + init(string:)
    @@ -415,8 +418,8 @@

    Declaration

    diff --git a/docs/Structs/GreaterThanOrEqual.html b/docs/Structs/GreaterThanOrEqual.html index 08b7248..8b55665 100644 --- a/docs/Structs/GreaterThanOrEqual.html +++ b/docs/Structs/GreaterThanOrEqual.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    GreaterThanOrEqual

    -
    public struct GreaterThanOrEqual<I: Identifier>: Operation
    +
    public struct GreaterThanOrEqual<I> : Operation where I : Identifier
    @@ -275,9 +278,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -302,9 +305,9 @@

    Declaration

  • - + - init(string:) + init(string:)
    @@ -415,8 +418,8 @@

    Declaration

    diff --git a/docs/Structs/InclusiveRange.html b/docs/Structs/InclusiveRange.html index 220b4e2..a1568b2 100644 --- a/docs/Structs/InclusiveRange.html +++ b/docs/Structs/InclusiveRange.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    InclusiveRange

    -
    public struct InclusiveRange<I: Identifier>: Operation
    +
    public struct InclusiveRange<I> : Operation where I : Identifier
    @@ -275,9 +278,9 @@

    Usage Example:

  • - + - init(start:end:) + init(start:end:)
    @@ -302,9 +305,9 @@

    Declaration

  • - + - init(string:) + init(string:)
    @@ -415,8 +418,8 @@

    Declaration

    diff --git a/docs/Structs/LowerThan.html b/docs/Structs/LowerThan.html index f104d97..1966e91 100644 --- a/docs/Structs/LowerThan.html +++ b/docs/Structs/LowerThan.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    LowerThan

    -
    public struct LowerThan<I: Identifier>: Operation
    +
    public struct LowerThan<I> : Operation where I : Identifier
    @@ -276,9 +279,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -303,9 +306,9 @@

    Declaration

  • - + - init(string:) + init(string:)
    @@ -416,8 +419,8 @@

    Declaration

    diff --git a/docs/Structs/LowerThanOrEqual.html b/docs/Structs/LowerThanOrEqual.html index af9bf05..15b5b0c 100644 --- a/docs/Structs/LowerThanOrEqual.html +++ b/docs/Structs/LowerThanOrEqual.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    LowerThanOrEqual

    -
    public struct LowerThanOrEqual<I: Identifier>: Operation
    +
    public struct LowerThanOrEqual<I> : Operation where I : Identifier
    @@ -275,9 +278,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -302,9 +305,9 @@

    Declaration

  • - + - init(string:) + init(string:)
    @@ -415,8 +418,8 @@

    Declaration

    diff --git a/docs/Structs/Ordering.html b/docs/Structs/Ordering.html index e99b3ce..d1321f8 100644 --- a/docs/Structs/Ordering.html +++ b/docs/Structs/Ordering.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    Ordering

    -
    public struct Ordering: Codable
    +
    public struct Ordering : Codable
    @@ -266,9 +269,9 @@

    Usage Example:

  • - + - init(by:) + init(by:)
    @@ -293,9 +296,9 @@

    Declaration

  • - + - init(by:) + init(by:)
    @@ -352,8 +355,8 @@

    Declaration

    diff --git a/docs/Structs/Pagination.html b/docs/Structs/Pagination.html index 169c289..75b285c 100644 --- a/docs/Structs/Pagination.html +++ b/docs/Structs/Pagination.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    Pagination

    -
    public struct Pagination: Codable
    +
    public struct Pagination : Codable
    @@ -270,9 +273,9 @@

    Usage Example:

  • - + - init(start:size:) + init(start:size:)
    @@ -287,7 +290,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public init(start: Int  = 0, size: Int)
    +
    public init(start: Int = 0, size: Int)
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/Structs/RequestError.html b/docs/Structs/RequestError.html index 91dd82f..79c26d8 100644 --- a/docs/Structs/RequestError.html +++ b/docs/Structs/RequestError.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    RequestError

    -
    public struct RequestError: RawRepresentable, Equatable, Hashable, Comparable, Error, CustomStringConvertible
    +
    public struct RequestError : RawRepresentable, Equatable, Hashable, Comparable, Error, CustomStringConvertible
    @@ -342,9 +345,9 @@

    Creating a RequestError from a numeric code

  • - + - init(rawValue:) + init(rawValue:)
    @@ -388,9 +391,9 @@

    Parameters

  • - + - init(rawValue:reason:) + init(rawValue:reason:)
    @@ -446,9 +449,9 @@

    Parameters

  • - + - init(_:body:) + init(_:body:)
    @@ -464,7 +467,7 @@

    Parameters

    Declaration

    Swift

    -
    public init<Body: Codable>(_ base: RequestError, body: Body)
    +
    public init<Body>(_ base: RequestError, body: Body) where Body : Decodable, Body : Encodable
    @@ -505,9 +508,9 @@

    Parameters

  • - + - init(_:bodyData:format:) + init(_:bodyData:format:)
    @@ -666,9 +669,9 @@

    Declaration

    • nil if there is no body
    • -
    • a (type-erased) Codable object if the error was initialized with init(_:body:)
    • +
    • a (type-erased) Codable object if the error was initialized with init(_:body:)
    • bytes of data and a signifier of the format in which they are stored (eg: JSON) -if the error was initialized with init(_:bodyData:format:)
    • +if the error was initialized with init(_:bodyData:format:)

    Usage example:

    if let errorBody = error.body {
    @@ -681,7 +684,7 @@ 

    Usage example:

    Note

    If you need a Codable representation and the body is data, you - can call the bodyAs(_:) function to get the converted value. + can call the bodyAs(_:) function to get the converted value.
    @@ -690,7 +693,7 @@

    Usage example:

    Declaration

    Swift

    -
    public private(set) var body: ErrorBody? = nil
    +
    public private(set) var body: RequestError.ErrorBody?
    @@ -700,9 +703,9 @@

    Declaration

  • - + - encodeBody(_:) + encodeBody(_:)
    @@ -713,7 +716,7 @@

    Declaration

    Returns the Codable error body encoded into bytes in a given format (eg: JSON).

    This function should be used if the RequestError was created using -init(_:body:), otherwise it will return nil.

    +init(_:body:), otherwise it will return nil.

    Note

    This function is primarily intended for use by the Kitura Router so @@ -774,7 +777,7 @@

    Parameters

    Return Value

    The Data object or nil if there is no body, or if the - error was not initialized with init(_:body:).

    + error was not initialized with init(_:body:).

    @@ -782,9 +785,9 @@

    Return Value

  • - + - decodeBody(_:) + decodeBody(_:)
    @@ -795,9 +798,9 @@

    Return Value

    Returns the Data error body as the requested Codable type.

    This function should be used if the RequestError was created using -init(_:bodyData:format:), otherwise it will return nil.

    +init(_:bodyData:format:), otherwise it will return nil.

    -

    This function throws; you can use bodyAs(_:) instead if you want +

    This function throws; you can use bodyAs(_:) instead if you want to ignore DecodingErrors.

    Note

    @@ -826,7 +829,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public func decodeBody<Body: Codable>(_ type: Body.Type) throws -> Body?
    +
    public func decodeBody<Body>(_ type: Body.Type) throws -> Body? where Body : Decodable, Body : Encodable
    @@ -853,7 +856,7 @@

    Parameters

    Return Value

    The Codable object or nil if there is no body or if the - error was not initialized with init(_:bodyData:format:).

    + error was not initialized with init(_:bodyData:format:).

    @@ -861,9 +864,9 @@

    Return Value

  • - + - bodyAs(_:) + bodyAs(_:)
    @@ -874,10 +877,10 @@

    Return Value

    Returns the Data error body as the requested Codable type.

    This function should be used if the RequestError was created using -init(_:bodyData:format:), otherwise it will return nil.

    +init(_:bodyData:format:), otherwise it will return nil.

    This function ignores DecodingErrors, and returns nil if decoding -fails. If you want DecodingErrors to be thrown, use decodeBody(_:) +fails. If you want DecodingErrors to be thrown, use decodeBody(_:) instead.

    Note

    @@ -897,7 +900,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public func bodyAs<Body: Codable>(_ type: Body.Type) -> Body?
    +
    public func bodyAs<Body>(_ type: Body.Type) -> Body? where Body : Decodable, Body : Encodable
    @@ -924,7 +927,7 @@

    Parameters

    Return Value

    The Codable object or nil if there is no body, or if the - error was not initialized with init(_:bodyData:format:), or + error was not initialized with init(_:bodyData:format:), or if decoding fails.

    @@ -944,9 +947,9 @@

    Comparing RequestErrors

  • - + - <(_:_:) + <(_:_:)
    @@ -971,9 +974,9 @@

    Declaration

  • - + - ==(_:_:) + ==(_:_:)
    @@ -1026,7 +1029,7 @@

    Describing a RequestError

    Declaration

    Swift

    -
    public var description: String
    +
    public var description: String { get }
    @@ -1053,7 +1056,7 @@

    Declaration

    Declaration

    Swift

    -
    public var hashValue: Int
    +
    public var hashValue: Int { get }
    @@ -1087,7 +1090,7 @@

    Declaration

    Declaration

    Swift

    -
    public var httpCode: Int
    +
    public var httpCode: Int { get }
    @@ -1097,9 +1100,9 @@

    Declaration

  • - + - init(httpCode:) + init(httpCode:)
    @@ -1171,7 +1174,7 @@

    Accessing constants representing HTTP status codes

    Declaration

    Swift

    -
    public static let `continue` = RequestError(httpCode: 100)
    +
    public static let `continue`: RequestError
    @@ -1198,7 +1201,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let switchingProtocols = RequestError(httpCode: 101)
    +
    public static let switchingProtocols: RequestError
    @@ -1225,7 +1228,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let ok = RequestError(httpCode: 200)
    +
    public static let ok: RequestError
    @@ -1252,7 +1255,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let created = RequestError(httpCode: 201)
    +
    public static let created: RequestError
    @@ -1279,7 +1282,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let accepted = RequestError(httpCode: 202)
    +
    public static let accepted: RequestError
    @@ -1306,7 +1309,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let nonAuthoritativeInformation = RequestError(httpCode: 203)
    +
    public static let nonAuthoritativeInformation: RequestError
    @@ -1333,7 +1336,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let noContent = RequestError(httpCode: 204)
    +
    public static let noContent: RequestError
    @@ -1360,7 +1363,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let resetContent = RequestError(httpCode: 205)
    +
    public static let resetContent: RequestError
    @@ -1387,7 +1390,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let partialContent = RequestError(httpCode: 206)
    +
    public static let partialContent: RequestError
    @@ -1414,7 +1417,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let multiStatus = RequestError(httpCode: 207)
    +
    public static let multiStatus: RequestError
    @@ -1441,7 +1444,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let alreadyReported = RequestError(httpCode: 208)
    +
    public static let alreadyReported: RequestError
    @@ -1468,7 +1471,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let imUsed = RequestError(httpCode: 226)
    +
    public static let imUsed: RequestError
    @@ -1495,7 +1498,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let multipleChoices = RequestError(httpCode: 300)
    +
    public static let multipleChoices: RequestError
    @@ -1522,7 +1525,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let movedPermanently = RequestError(httpCode: 301)
    +
    public static let movedPermanently: RequestError
    @@ -1549,7 +1552,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let found = RequestError(httpCode: 302)
    +
    public static let found: RequestError
    @@ -1576,7 +1579,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let seeOther = RequestError(httpCode: 303)
    +
    public static let seeOther: RequestError
    @@ -1603,7 +1606,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let notModified = RequestError(httpCode: 304)
    +
    public static let notModified: RequestError
    @@ -1630,7 +1633,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let useProxy = RequestError(httpCode: 305)
    +
    public static let useProxy: RequestError
    @@ -1657,7 +1660,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let temporaryRedirect = RequestError(httpCode: 307)
    +
    public static let temporaryRedirect: RequestError
    @@ -1684,7 +1687,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let permanentRedirect = RequestError(httpCode: 308)
    +
    public static let permanentRedirect: RequestError
    @@ -1711,7 +1714,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let badRequest = RequestError(httpCode: 400)
    +
    public static let badRequest: RequestError
    @@ -1738,7 +1741,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let unauthorized = RequestError(httpCode: 401)
    +
    public static let unauthorized: RequestError
    @@ -1765,7 +1768,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let paymentRequired = RequestError(httpCode: 402)
    +
    public static let paymentRequired: RequestError
    @@ -1792,7 +1795,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let forbidden = RequestError(httpCode: 403)
    +
    public static let forbidden: RequestError
    @@ -1819,7 +1822,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let notFound = RequestError(httpCode: 404)
    +
    public static let notFound: RequestError
    @@ -1846,7 +1849,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let methodNotAllowed = RequestError(httpCode: 405)
    +
    public static let methodNotAllowed: RequestError
    @@ -1873,7 +1876,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let notAcceptable = RequestError(httpCode: 406)
    +
    public static let notAcceptable: RequestError
    @@ -1900,7 +1903,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let proxyAuthenticationRequired = RequestError(httpCode: 407)
    +
    public static let proxyAuthenticationRequired: RequestError
    @@ -1927,7 +1930,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let requestTimeout = RequestError(httpCode: 408)
    +
    public static let requestTimeout: RequestError
    @@ -1954,7 +1957,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let conflict = RequestError(httpCode: 409)
    +
    public static let conflict: RequestError
    @@ -1981,7 +1984,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let gone = RequestError(httpCode: 410)
    +
    public static let gone: RequestError
    @@ -2008,7 +2011,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let lengthRequired = RequestError(httpCode: 411)
    +
    public static let lengthRequired: RequestError
    @@ -2035,7 +2038,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let preconditionFailed = RequestError(httpCode: 412)
    +
    public static let preconditionFailed: RequestError
    @@ -2062,7 +2065,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let payloadTooLarge = RequestError(httpCode: 413)
    +
    public static let payloadTooLarge: RequestError
    @@ -2089,7 +2092,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let uriTooLong = RequestError(httpCode: 414)
    +
    public static let uriTooLong: RequestError
    @@ -2116,7 +2119,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let unsupportedMediaType = RequestError(httpCode: 415)
    +
    public static let unsupportedMediaType: RequestError
    @@ -2143,7 +2146,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let rangeNotSatisfiable = RequestError(httpCode: 416)
    +
    public static let rangeNotSatisfiable: RequestError
    @@ -2170,7 +2173,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let expectationFailed = RequestError(httpCode: 417)
    +
    public static let expectationFailed: RequestError
    @@ -2197,7 +2200,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let misdirectedRequest = RequestError(httpCode: 421)
    +
    public static let misdirectedRequest: RequestError
    @@ -2224,7 +2227,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let unprocessableEntity = RequestError(httpCode: 422)
    +
    public static let unprocessableEntity: RequestError
    @@ -2251,7 +2254,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let locked = RequestError(httpCode: 423)
    +
    public static let locked: RequestError
    @@ -2278,7 +2281,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let failedDependency = RequestError(httpCode: 424)
    +
    public static let failedDependency: RequestError
    @@ -2305,7 +2308,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let upgradeRequired = RequestError(httpCode: 426)
    +
    public static let upgradeRequired: RequestError
    @@ -2332,7 +2335,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let preconditionRequired = RequestError(httpCode: 428)
    +
    public static let preconditionRequired: RequestError
    @@ -2359,7 +2362,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let tooManyRequests = RequestError(httpCode: 429)
    +
    public static let tooManyRequests: RequestError
    @@ -2386,7 +2389,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let requestHeaderFieldsTooLarge = RequestError(httpCode: 431)
    +
    public static let requestHeaderFieldsTooLarge: RequestError
    @@ -2413,7 +2416,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let unavailableForLegalReasons = RequestError(httpCode: 451)
    +
    public static let unavailableForLegalReasons: RequestError
    @@ -2440,7 +2443,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let internalServerError = RequestError(httpCode: 500)
    +
    public static let internalServerError: RequestError
    @@ -2467,7 +2470,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let notImplemented = RequestError(httpCode: 501)
    +
    public static let notImplemented: RequestError
    @@ -2494,7 +2497,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let badGateway = RequestError(httpCode: 502)
    +
    public static let badGateway: RequestError
    @@ -2521,7 +2524,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let serviceUnavailable = RequestError(httpCode: 503)
    +
    public static let serviceUnavailable: RequestError
    @@ -2548,7 +2551,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let gatewayTimeout = RequestError(httpCode: 504)
    +
    public static let gatewayTimeout: RequestError
    @@ -2575,7 +2578,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let httpVersionNotSupported = RequestError(httpCode: 505)
    +
    public static let httpVersionNotSupported: RequestError
    @@ -2602,7 +2605,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let variantAlsoNegotiates = RequestError(httpCode: 506)
    +
    public static let variantAlsoNegotiates: RequestError
    @@ -2629,7 +2632,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let insufficientStorage = RequestError(httpCode: 507)
    +
    public static let insufficientStorage: RequestError
    @@ -2656,7 +2659,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let loopDetected = RequestError(httpCode: 508)
    +
    public static let loopDetected: RequestError
    @@ -2683,7 +2686,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let notExtended = RequestError(httpCode: 510)
    +
    public static let notExtended: RequestError
    @@ -2710,7 +2713,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let networkAuthenticationRequired = RequestError(httpCode: 511)
    +
    public static let networkAuthenticationRequired: RequestError
    @@ -2725,8 +2728,8 @@

    Declaration

    diff --git a/docs/Structs/RequestError/ErrorBody.html b/docs/Structs/RequestError/ErrorBody.html index 73da0df..7926180 100644 --- a/docs/Structs/RequestError/ErrorBody.html +++ b/docs/Structs/RequestError/ErrorBody.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -262,9 +265,9 @@

    ErrorBody

  • - - - codable + + + codable(_:)
    @@ -286,16 +289,12 @@

    Declaration

  • - - -
    -
    diff --git a/docs/Structs/UnsupportedBodyFormatError.html b/docs/Structs/UnsupportedBodyFormatError.html index fdd6c5b..3943bbc 100644 --- a/docs/Structs/UnsupportedBodyFormatError.html +++ b/docs/Structs/UnsupportedBodyFormatError.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

    + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    UnsupportedBodyFormatError

    -
    public struct UnsupportedBodyFormatError: Error
    +
    public struct UnsupportedBodyFormatError : Error
    @@ -289,9 +292,9 @@

    Declaration

  • - + - init(_:) + init(_:)
    @@ -321,8 +324,8 @@

    Declaration

    diff --git a/docs/Typealiases.html b/docs/Typealiases.html index 8a51f21..1e0c012 100644 --- a/docs/Typealiases.html +++ b/docs/Typealiases.html @@ -14,6 +14,7 @@ + @@ -22,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -86,6 +87,9 @@

  • + @@ -143,7 +147,7 @@ Operation @@ -317,7 +321,7 @@

    Declaration

    Declaration

    Swift

    -
    public typealias CodableResultClosure<O: Codable> = (O?, RequestError?) -> Void
    +
    public typealias CodableResultClosure<O> = (O?, RequestError?) -> Void where O : Decodable, O : Encodable
    @@ -348,7 +352,7 @@

    Declaration

    Declaration

    Swift

    -
    public typealias CodableArrayResultClosure<O: Codable> = ([O]?, RequestError?) -> Void
    +
    public typealias CodableArrayResultClosure<O> = ([O]?, RequestError?) -> Void where O : Decodable, O : Encodable
    @@ -379,7 +383,7 @@

    Declaration

    Declaration

    Swift

    -
    public typealias IdentifierCodableArrayResultClosure<Id: Identifier, O: Codable> = ([(Id, O)]?, RequestError?) -> Void
    +
    public typealias IdentifierCodableArrayResultClosure<Id, O> = ([(Id, O)]?, RequestError?) -> Void where Id : Identifier, O : Decodable, O : Encodable
    @@ -410,7 +414,7 @@

    Declaration

    Declaration

    Swift

    -
    public typealias IdentifierCodableResultClosure<Id: Identifier, O: Codable> = (Id?, O?, RequestError?) -> Void
    +
    public typealias IdentifierCodableResultClosure<Id, O> = (Id?, O?, RequestError?) -> Void where Id : Identifier, O : Decodable, O : Encodable
    @@ -802,8 +806,8 @@

    Declaration

    diff --git a/docs/badge.svg b/docs/badge.svg index a096fec..bfac052 100644 --- a/docs/badge.svg +++ b/docs/badge.svg @@ -1,15 +1,15 @@ - + - + - - + + @@ -18,11 +18,11 @@ documentation - - 100% + + 99% - - 100% + + 99% diff --git a/docs/css/jazzy.css b/docs/css/jazzy.css index c83db5b..24cfe4a 100644 --- a/docs/css/jazzy.css +++ b/docs/css/jazzy.css @@ -63,6 +63,10 @@ a { a:hover, a:focus { outline: 0; text-decoration: underline; } + a.discouraged { + text-decoration: line-through; } + a.discouraged:hover, a.discouraged:focus { + text-decoration: underline line-through; } table { background: #fff; @@ -225,7 +229,7 @@ pre code { .item a[name]:before { content: ""; display: block; } - .item .token { + .item .token, .item .direct-link { padding-left: 3px; margin-left: 0px; font-size: 1rem; } @@ -287,9 +291,9 @@ pre code { .language .aside-title { color: #4183c4; } -.aside-warning { +.aside-warning, .aside-deprecated, .aside-unavailable { border-left: 5px solid #ff6666; } - .aside-warning .aside-title { + .aside-warning .aside-title, .aside-deprecated .aside-title, .aside-unavailable .aside-title { color: #ff0000; } .graybox { diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Classes.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Classes.html index 465411d..b928b00 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Classes.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Classes.html @@ -14,6 +14,7 @@ + @@ -22,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -86,6 +87,9 @@

    + @@ -143,7 +147,7 @@ Operation @@ -326,7 +330,7 @@

    Decoding Empty Values:

    Declaration

    Swift

    -
    public class QueryDecoder: Coder, Decoder, BodyDecoder
    +
    public class QueryDecoder : Coder, Decoder, BodyDecoder
    @@ -369,7 +373,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public class QueryEncoder: Coder, Encoder, BodyEncoder
    +
    public class QueryEncoder : Coder, Encoder, BodyEncoder
    @@ -384,8 +388,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Classes/Coder.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Classes/Coder.html index 3883943..7109264 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Classes/Coder.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Classes/Coder.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

    + @@ -144,7 +147,7 @@ Operation @@ -264,9 +267,9 @@

    Usage Example:

  • - + - dateFormatter + dateFormatter
    @@ -322,9 +325,9 @@

    Declaration

  • - + - getFieldName(from:) + getFieldName(from:)
    @@ -357,8 +360,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Classes/QueryDecoder.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Classes/QueryDecoder.html index 36d299f..43d5ce6 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Classes/QueryDecoder.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Classes/QueryDecoder.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    QueryDecoder

    -
    public class QueryDecoder: Coder, Decoder, BodyDecoder
    +
    public class QueryDecoder : Coder, Decoder, BodyDecoder
    @@ -300,7 +303,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public var codingPath: [CodingKey] = []
    +
    public var codingPath: [CodingKey]
    @@ -310,9 +313,9 @@

    Declaration

  • - + - userInfo + userInfo
    @@ -327,7 +330,7 @@

    Declaration

    Declaration

    Swift

    -
    public var userInfo: [CodingUserInfoKey : Any] = [:]
    +
    public var userInfo: [CodingUserInfoKey : Any]
    @@ -337,9 +340,9 @@

    Declaration

  • - + - dictionary + dictionary
    @@ -391,9 +394,9 @@

    Declaration

  • - + - init(dictionary:) + init(dictionary:)
    @@ -418,9 +421,9 @@

    Declaration

  • - + - decode(_:from:) + decode(_:from:)
    @@ -441,7 +444,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public func decode<T: Decodable>(_ type: T.Type, from data: Data) throws -> T
    +
    public func decode<T>(_ type: T.Type, from data: Data) throws -> T where T : Decodable
    @@ -482,9 +485,9 @@

    Parameters

  • - + - decode(_:) + decode(_:)
    @@ -505,7 +508,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public func decode<T: Decodable>(_ type: T.Type) throws -> T
    +
    public func decode<T>(_ type: T.Type) throws -> T where T : Decodable
    @@ -534,9 +537,9 @@

    Parameters

  • - + - container(keyedBy:) + container(keyedBy:)
    @@ -629,8 +632,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Classes/QueryEncoder.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Classes/QueryEncoder.html index eeeeb60..4df2b39 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Classes/QueryEncoder.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Classes/QueryEncoder.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    QueryEncoder

    -
    public class QueryEncoder: Coder, Encoder, BodyEncoder
    +
    public class QueryEncoder : Coder, Encoder, BodyEncoder
    @@ -292,7 +295,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public var codingPath: [CodingKey] = []
    +
    public var codingPath: [CodingKey]
    @@ -302,9 +305,9 @@

    Declaration

  • - + - userInfo + userInfo
    @@ -319,7 +322,7 @@

    Declaration

    Declaration

    Swift

    -
    public var userInfo: [CodingUserInfoKey: Any] = [:]
    +
    public var userInfo: [CodingUserInfoKey : Any]
    @@ -356,9 +359,9 @@

    Declaration

  • - + - encode(_:) + encode(_:)
    @@ -379,7 +382,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public func encode<T: Encodable>(_ value: T) throws -> String
    +
    public func encode<T>(_ value: T) throws -> String where T : Encodable
    @@ -408,9 +411,9 @@

    Parameters

  • - + - encode(_:) + encode(_:)
    @@ -431,7 +434,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public func encode<T : Encodable>(_ value: T) throws -> Data
    +
    public func encode<T>(_ value: T) throws -> Data where T : Encodable
    @@ -460,9 +463,9 @@

    Parameters

  • - + - encode(_:) + encode(_:)
    @@ -483,7 +486,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public func encode<T: Encodable>(_ value: T) throws -> [URLQueryItem]
    +
    public func encode<T>(_ value: T) throws -> [URLQueryItem] where T : Encodable
    @@ -512,9 +515,9 @@

    Parameters

  • - + - encode(_:) + encode(_:)
    @@ -535,7 +538,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public func encode<T: Encodable>(_ value: T) throws -> [String : String]
    +
    public func encode<T>(_ value: T) throws -> [String : String] where T : Encodable
    @@ -564,9 +567,9 @@

    Parameters

  • - + - encode(_:) + encode(_:)
    @@ -581,7 +584,7 @@

    Parameters

    Declaration

    Swift

    -
    public func encode<T: Encodable>(_ value: T) throws -> [String : Any]
    +
    public func encode<T>(_ value: T) throws -> [String : Any] where T : Encodable
    @@ -591,9 +594,9 @@

    Declaration

  • - + - container(keyedBy:) + container(keyedBy:)
    @@ -686,8 +689,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Enums.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Enums.html index bf970a1..0002119 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Enums.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Enums.html @@ -14,6 +14,7 @@ + @@ -22,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -86,6 +87,9 @@

  • + @@ -143,7 +147,7 @@ Operation @@ -267,7 +271,7 @@

    Enumerations

    An error representing a failure to create an Identifier.

    Usage Example:

    -

    An QueryParamsError.invalidValue may be thrown if the given type cannot be constructed from the given string.

    +

    An QueryParamsError.invalidValue may be thrown if the given type cannot be constructed from the given string.

     throw QueryParamsError.invalidValue
     
    @@ -277,7 +281,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public enum QueryParamsError: Error
    +
    public enum QueryParamsError : Error
    @@ -300,7 +304,7 @@

    Declaration

    An error representing a failure to create an Identifier.

    Usage Example:

    -

    An IdentifierError.invalidValue may be thrown if the given string cannot be converted to an integer when using an Identifier.

    +

    An IdentifierError.invalidValue may be thrown if the given string cannot be converted to an integer when using an Identifier.

     throw IdentifierError.invalidValue
     
    @@ -310,7 +314,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public enum IdentifierError: Error
    +
    public enum IdentifierError : Error
    @@ -343,7 +347,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public enum Order: Codable
    +
    public enum Order : Codable
    @@ -376,7 +380,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public enum Operator: String, Codable
    +
    public enum Operator : String, Codable
    @@ -391,8 +395,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Enums/IdentifierError.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Enums/IdentifierError.html index 262490a..e5e9227 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Enums/IdentifierError.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Enums/IdentifierError.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

    + @@ -144,7 +147,7 @@ Operation @@ -245,14 +248,14 @@

    IdentifierError

    -
    public enum IdentifierError: Error
    +
    public enum IdentifierError : Error

    An error representing a failure to create an Identifier.

    Usage Example:

    -

    An IdentifierError.invalidValue may be thrown if the given string cannot be converted to an integer when using an Identifier.

    +

    An IdentifierError.invalidValue may be thrown if the given string cannot be converted to an integer when using an Identifier.

     throw IdentifierError.invalidValue
     
    @@ -266,9 +269,9 @@

    Usage Example:

  • - + - invalidValue + invalidValue
    @@ -298,8 +301,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Enums/Operator.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Enums/Operator.html index b36b455..586982c 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Enums/Operator.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Enums/Operator.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    Operator

    -
    public enum Operator: String, Codable
    +
    public enum Operator : String, Codable
    @@ -266,9 +269,9 @@

    Usage Example:

  • - + - or + or
    @@ -290,16 +293,12 @@

    Declaration

  • - - -
    -
    • - + - equal + equal
      @@ -321,16 +320,12 @@

      Declaration

    • -
    -
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    - -
    -
    -
    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Enums/Order.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Enums/Order.html index 8427c0d..7504aa8 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Enums/Order.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Enums/Order.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

    + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    Order

    -
    public enum Order: Codable
    +
    public enum Order : Codable
    @@ -266,9 +269,9 @@

    Usage Example:

  • - - - asc + + + asc(_:)
    @@ -290,16 +293,12 @@

    Declaration

  • - - -
    -
    • - - - desc + + + desc(_:)
      @@ -321,16 +320,12 @@

      Declaration

    • -
    -
    -
    -
    • @@ -354,9 +349,9 @@

      Declaration

    • @@ -397,7 +392,7 @@

      Declaration

      Declaration

      Swift

      -
      public var description: String
      +
      public var description: String { get }
      @@ -424,7 +419,7 @@

      Declaration

      Declaration

      Swift

      -
      public var value: String
      +
      public var value: String { get }
    @@ -439,8 +434,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Enums/QueryParamsError.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Enums/QueryParamsError.html index 73035a9..f5163a1 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Enums/QueryParamsError.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Enums/QueryParamsError.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

    + @@ -144,7 +147,7 @@ Operation @@ -245,14 +248,14 @@

    QueryParamsError

    -
    public enum QueryParamsError: Error
    +
    public enum QueryParamsError : Error

    An error representing a failure to create an Identifier.

    Usage Example:

    -

    An QueryParamsError.invalidValue may be thrown if the given type cannot be constructed from the given string.

    +

    An QueryParamsError.invalidValue may be thrown if the given type cannot be constructed from the given string.

     throw QueryParamsError.invalidValue
     
    @@ -266,9 +269,9 @@

    Usage Example:

  • - + - invalidValue + invalidValue
    @@ -298,8 +301,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions.html index dab8984..2b40e99 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions.html @@ -14,6 +14,7 @@ + @@ -22,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -86,6 +87,9 @@

  • + @@ -143,7 +147,7 @@ Operation @@ -279,6 +283,34 @@

    Declaration

    +
  • +
    + + + + DateError + +
    +
    +
    +
    +
    +
    +

    Undocumented

    + + See more +
    +
    +

    Declaration

    +
    +

    Swift

    +
    enum DateError : Error
    + +
    +
    +
    +
    +
  • @@ -692,8 +724,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Bool.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Bool.html index 578215b..5c13511 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Bool.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Bool.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

    + @@ -144,7 +147,7 @@ Operation @@ -260,9 +263,9 @@

    Bool

  • - + - init(value:) + init(value:)
    @@ -273,7 +276,7 @@

    Bool

    Creates a bool identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to a Bool. + An IdentifierError.invalidValue if the given string cannot be converted to a Bool.
    @@ -309,7 +312,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -324,8 +327,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/DateError.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/DateError.html new file mode 100644 index 0000000..7657a0e --- /dev/null +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/DateError.html @@ -0,0 +1,303 @@ + + + + DateError Extension Reference + + + + + + + + + + + + + + + + +
    +

    + + KituraContracts Docs + + (99% documented) +

    + +

    +

    + +
    +

    + +

    + + + View on GitHub + +

    + +
    + + + +
    + +
    + +
    +
    +

    DateError

    +
    +
    +
    enum DateError : Error
    + +
    +
    +

    Undocumented

    + +
    +
    + +
    +
    +
    +
      +
    • +
      + + + + errorDescription + +
      +
      +
      +
      +
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      public var errorDescription: String? { get }
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + + + diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Double.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Double.html index 7f4d728..1886abc 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Double.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Double.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -260,9 +263,9 @@

    Double

  • - + - init(value:) + init(value:)
    @@ -273,7 +276,7 @@

    Double

    Creates a double identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to a Double. + An IdentifierError.invalidValue if the given string cannot be converted to a Double.
    @@ -309,7 +312,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -324,8 +327,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Float.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Float.html index 35304ef..0f2942d 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Float.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Float.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -260,9 +263,9 @@

    Float

  • - + - init(value:) + init(value:)
    @@ -273,7 +276,7 @@

    Float

    Creates a float identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to a Float. + An IdentifierError.invalidValue if the given string cannot be converted to a Float.
    @@ -309,7 +312,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -324,8 +327,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Int.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Int.html index 7014b6a..c3cf07d 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Int.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Int.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -278,7 +281,7 @@

    Usage Example:

    Creates an integer identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to an integer. + An IdentifierError.invalidValue if the given string cannot be converted to an integer.
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Int16.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Int16.html index 2a2d0ab..077e7cf 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Int16.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Int16.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -278,7 +281,7 @@

    Usage Example:

    Creates an integer identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to an integer. + An IdentifierError.invalidValue if the given string cannot be converted to an integer.
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Int32.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Int32.html index 5c5e564..611b239 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Int32.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Int32.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -278,7 +281,7 @@

    Usage Example:

    Creates an integer identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to an integer. + An IdentifierError.invalidValue if the given string cannot be converted to an integer.
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Int64.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Int64.html index 44118ca..3a9d13c 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Int64.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Int64.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -278,7 +281,7 @@

    Usage Example:

    Creates an integer identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to an integer. + An IdentifierError.invalidValue if the given string cannot be converted to an integer.
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Int8.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Int8.html index 0555ee5..8db56b0 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Int8.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/Int8.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -278,7 +281,7 @@

    Usage Example:

    Creates an integer identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to an integer. + An IdentifierError.invalidValue if the given string cannot be converted to an integer.
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/String.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/String.html index 17506c7..8a5c788 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/String.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/String.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -278,7 +281,7 @@

    String

    Declaration

    Swift

    -
    public var int: Int?
    +
    public var int: Int? { get }
    @@ -305,7 +308,7 @@

    Declaration

    Declaration

    Swift

    -
    public var int8: Int8?
    +
    public var int8: Int8? { get }
    @@ -332,7 +335,7 @@

    Declaration

    Declaration

    Swift

    -
    public var int16: Int16?
    +
    public var int16: Int16? { get }
    @@ -359,7 +362,7 @@

    Declaration

    Declaration

    Swift

    -
    public var int32: Int32?
    +
    public var int32: Int32? { get }
    @@ -386,7 +389,7 @@

    Declaration

    Declaration

    Swift

    -
    public var int64: Int64?
    +
    public var int64: Int64? { get }
    @@ -413,7 +416,7 @@

    Declaration

    Declaration

    Swift

    -
    public var uInt: UInt?
    +
    public var uInt: UInt? { get }
    @@ -440,7 +443,7 @@

    Declaration

    Declaration

    Swift

    -
    public var uInt8: UInt8?
    +
    public var uInt8: UInt8? { get }
    @@ -467,7 +470,7 @@

    Declaration

    Declaration

    Swift

    -
    public var uInt16: UInt16?
    +
    public var uInt16: UInt16? { get }
    @@ -494,7 +497,7 @@

    Declaration

    Declaration

    Swift

    -
    public var uInt32: UInt32?
    +
    public var uInt32: UInt32? { get }
    @@ -521,7 +524,7 @@

    Declaration

    Declaration

    Swift

    -
    public var uInt64: UInt64?
    +
    public var uInt64: UInt64? { get }
    @@ -548,7 +551,7 @@

    Declaration

    Declaration

    Swift

    -
    public var float: Float?
    +
    public var float: Float? { get }
    @@ -575,7 +578,7 @@

    Declaration

    Declaration

    Swift

    -
    public var double: Double?
    +
    public var double: Double? { get }
    @@ -602,7 +605,7 @@

    Declaration

    Declaration

    Swift

    -
    public var boolean: Bool?
    +
    public var boolean: Bool? { get }
    @@ -629,7 +632,7 @@

    Declaration

    Declaration

    Swift

    -
    public var string: String
    +
    public var string: String { get }
    @@ -656,7 +659,7 @@

    Declaration

    Declaration

    Swift

    -
    public var intArray: [Int]?
    +
    public var intArray: [Int]? { get }
    @@ -683,7 +686,7 @@

    Declaration

    Declaration

    Swift

    -
    public var int8Array: [Int8]?
    +
    public var int8Array: [Int8]? { get }
    @@ -710,7 +713,7 @@

    Declaration

    Declaration

    Swift

    -
    public var int16Array: [Int16]?
    +
    public var int16Array: [Int16]? { get }
    @@ -737,7 +740,7 @@

    Declaration

    Declaration

    Swift

    -
    public var int32Array: [Int32]?
    +
    public var int32Array: [Int32]? { get }
    @@ -764,7 +767,7 @@

    Declaration

    Declaration

    Swift

    -
    public var int64Array: [Int64]?
    +
    public var int64Array: [Int64]? { get }
    @@ -791,7 +794,7 @@

    Declaration

    Declaration

    Swift

    -
    public var uIntArray: [UInt]?
    +
    public var uIntArray: [UInt]? { get }
    @@ -818,7 +821,7 @@

    Declaration

    Declaration

    Swift

    -
    public var uInt8Array: [UInt8]?
    +
    public var uInt8Array: [UInt8]? { get }
    @@ -845,7 +848,7 @@

    Declaration

    Declaration

    Swift

    -
    public var uInt16Array: [UInt16]?
    +
    public var uInt16Array: [UInt16]? { get }
    @@ -872,7 +875,7 @@

    Declaration

    Declaration

    Swift

    -
    public var uInt32Array: [UInt32]?
    +
    public var uInt32Array: [UInt32]? { get }
    @@ -899,7 +902,7 @@

    Declaration

    Declaration

    Swift

    -
    public var uInt64Array: [UInt64]?
    +
    public var uInt64Array: [UInt64]? { get }
    @@ -926,7 +929,7 @@

    Declaration

    Declaration

    Swift

    -
    public var floatArray: [Float]?
    +
    public var floatArray: [Float]? { get }
    @@ -953,7 +956,7 @@

    Declaration

    Declaration

    Swift

    -
    public var doubleArray: [Double]?
    +
    public var doubleArray: [Double]? { get }
    @@ -980,7 +983,7 @@

    Declaration

    Declaration

    Swift

    -
    public var booleanArray: [Bool]?
    +
    public var booleanArray: [Bool]? { get }
    @@ -1007,7 +1010,7 @@

    Declaration

    Declaration

    Swift

    -
    public var stringArray: [String]
    +
    public var stringArray: [String] { get }
    @@ -1017,9 +1020,9 @@

    Declaration

  • - + - decodable(_:) + decodable(_:)
    @@ -1034,7 +1037,7 @@

    Declaration

    Declaration

    Swift

    -
    public func decodable<T: Decodable>(_ type: T.Type) -> T?
    +
    public func decodable<T>(_ type: T.Type) -> T? where T : Decodable
    @@ -1067,9 +1070,9 @@

    Return Value

  • - + - date(_:) + date(_:)
    @@ -1117,9 +1120,9 @@

    Return Value

  • - + - dateArray(_:) + dateArray(_:)
    @@ -1164,6 +1167,80 @@

    Return Value

  • +
  • +
    + + + + dateArray(decoderStrategy:decoder:) + +
    +
    +
    +
    +
    +
    +

    Converts the given String to a [Date]? object using the dateDecodingStrategy supplied.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    +
    public func dateArray(decoderStrategy: JSONDecoder.DateDecodingStrategy = .formatted(Coder().dateFormatter), decoder: Decoder? = nil) -> [Date]?
    + +
    +
    +
    +

    Parameters

    + + + + + + + + + + + + + + + +
    + + formatter + + +
    +

    The designated DateFormatter to convert the string with.

    +
    +
    + + decoderStrategy + + +
    +

    The JSON.dateDecodingStrategy that should be used to decode the specifed Date. Default is set to .formatted with default dateFormatter.

    +
    +
    + + decoder + + +
    +

    The Decoder parameter is only used for the custom strategy.

    +
    +
    +
    +
    +

    Return Value

    +

    The [Date]? object. Some on success / nil on failure.

    +
    +
    +
    +
  • @@ -1171,9 +1248,9 @@

    Return Value

  • - + - init(value:) + init(value:)
    @@ -1215,7 +1292,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -1230,8 +1307,8 @@

    Declaration

  • diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/UInt.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/UInt.html index b543078..13c7da1 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/UInt.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/UInt.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

    + @@ -144,7 +147,7 @@ Operation @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -278,7 +281,7 @@

    Usage Example:

    Creates an unsigned integer identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to an unsigned integer. + An IdentifierError.invalidValue if the given string cannot be converted to an unsigned integer.
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/UInt16.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/UInt16.html index 69b8a67..a588cf4 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/UInt16.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/UInt16.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -278,7 +281,7 @@

    Usage Example:

    Creates an unsigned integer identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to an unsigned integer. + An IdentifierError.invalidValue if the given string cannot be converted to an unsigned integer.
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/UInt32.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/UInt32.html index 78b1c55..67c6efe 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/UInt32.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/UInt32.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -278,7 +281,7 @@

    Usage Example:

    Creates an unsigned integer identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to an unsigned integer. + An IdentifierError.invalidValue if the given string cannot be converted to an unsigned integer.
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/UInt64.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/UInt64.html index 847c9d3..a11ddd5 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/UInt64.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/UInt64.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -278,7 +281,7 @@

    Usage Example:

    Creates an unsigned integer identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to an unsigned integer. + An IdentifierError.invalidValue if the given string cannot be converted to an unsigned integer.
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/UInt8.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/UInt8.html index 972d82b..f41c254 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/UInt8.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Extensions/UInt8.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -278,7 +281,7 @@

    Usage Example:

    Creates an unsigned integer identifier from a given string representation.

    Throws

    - An IdentifierError.invalidValue if the given string cannot be converted to an unsigned integer. + An IdentifierError.invalidValue if the given string cannot be converted to an unsigned integer.
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    public var value: String
    +
    public var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols.html index af2873d..92b4687 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols.html @@ -14,6 +14,7 @@ + @@ -22,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -86,6 +87,9 @@

  • + @@ -143,7 +147,7 @@ Operation @@ -273,7 +277,7 @@

    Protocols

    Declaration

    Swift

    -
    public protocol BodyDecoder: AnyObject
    +
    public protocol BodyDecoder : AnyObject
    @@ -306,7 +310,7 @@

    Declaration

    Declaration

    Swift

    -
    public protocol BodyEncoder: AnyObject
    +
    public protocol BodyEncoder : AnyObject
    @@ -355,12 +359,13 @@

    Decoding Empty Values:

  • All other non-optional types throw a decoding error
  • + See more

    Declaration

    Swift

    -
    public protocol QueryParams: Codable
    +
    public protocol QueryParams : Decodable, Encodable
    @@ -392,7 +397,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public protocol Identifier: Codable
    +
    public protocol Identifier : Decodable, Encodable
    @@ -420,7 +425,7 @@

    Declaration

    Declaration

    Swift

    -
    public protocol Operation: Codable
    +
    public protocol Operation : Decodable, Encodable
    @@ -435,8 +440,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols/BodyDecoder.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols/BodyDecoder.html index 7210609..25a40f8 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols/BodyDecoder.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols/BodyDecoder.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

    + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    BodyDecoder

    -
    public protocol BodyDecoder: AnyObject
    +
    public protocol BodyDecoder : AnyObject
    @@ -262,9 +265,9 @@

    BodyDecoder

  • - + - decode(_:from:) + decode(_:from:)
    @@ -279,7 +282,7 @@

    BodyDecoder

    Declaration

    Swift

    -
    func decode<T : Decodable>(_ type: T.Type, from data: Data) throws -> T
    +
    func decode<T>(_ type: T.Type, from data: Data) throws -> T where T : Decodable
    @@ -294,8 +297,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols/BodyEncoder.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols/BodyEncoder.html index cc566b4..3a0fd47 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols/BodyEncoder.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols/BodyEncoder.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    BodyEncoder

    -
    public protocol BodyEncoder: AnyObject
    +
    public protocol BodyEncoder : AnyObject
    @@ -262,9 +265,9 @@

    BodyEncoder

  • - + - encode(_:) + encode(_:)
    @@ -279,7 +282,7 @@

    BodyEncoder

    Declaration

    Swift

    -
    func encode<T : Encodable>(_ value: T) throws -> Data
    +
    func encode<T>(_ value: T) throws -> Data where T : Encodable
    @@ -294,8 +297,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols/Identifier.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols/Identifier.html index 270eae9..578ecdf 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols/Identifier.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols/Identifier.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    Identifier

    -
    public protocol Identifier: Codable
    +
    public protocol Identifier : Decodable, Encodable
    @@ -265,9 +268,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -314,7 +317,7 @@

    Declaration

    Declaration

    Swift

    -
    var value: String
    +
    var value: String { get }
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols/Operation.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols/Operation.html index 910218a..e872043 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols/Operation.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols/Operation.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    Operation

    -
    public protocol Operation: Codable
    +
    public protocol Operation : Decodable, Encodable
    @@ -261,9 +264,9 @@

    Operation

  • - + - init(string:) + init(string:)
    @@ -337,7 +340,7 @@

    Declaration

    Returns the Operator associated with the Operation.

    -

    InclusiveRange(start: 5, end: 10) will have the operator Operator.inclusiveRange

    +

    InclusiveRange(start: 5, end: 10) will have the operator Operator.inclusiveRange

    @@ -359,8 +362,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols/QueryParams.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols/QueryParams.html new file mode 100644 index 0000000..7789bdb --- /dev/null +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Protocols/QueryParams.html @@ -0,0 +1,378 @@ + + + + QueryParams Protocol Reference + + + + + + + + + + + + + + + + +
    +

    + + KituraContracts Docs + + (99% documented) +

    + +

    +

    + +
    +

    + +

    + + + View on GitHub + +

    + +
    + + + +
    + +
    + +
    +
    +

    QueryParams

    +
    +
    +
    public protocol QueryParams : Decodable, Encodable
    + +
    +
    +

    An object that conforms to QueryParams is identified as being decodable from URLEncoded data. +This can be applied to a Codable route to define the names and types of the expected query parameters, and provide type-safe access to their values. The QueryDecoder is used to decode the URL encoded parameters into an instance of the conforming type.

    +

    Usage Example:

    +
    struct Query: QueryParams {
    +   let id: Int
    +}
    +router.get("/user") { (query: Query, respondWith: (User?, RequestError?) -> Void) in
    +    guard let user: User = userArray[query.id] else {
    +       return respondWith(nil, .notFound)
    +    }
    +    respondWith(user, nil)
    +}
    +
    +

    Decoding Empty Values:

    + +

    When an HTML form is sent with an empty or unchecked field, the corresponding key/value pair is sent with an empty value (i.e. &key1=&key2=). +The corresponding mapping to Swift types performed by QueryDecoder is as follows:

    + +
      +
    • Any Optional type (including String?) defaults to nil
    • +
    • Non-optional String successfully decodes to ""
    • +
    • Non-optional Bool decodes to false
    • +
    • All other non-optional types throw a decoding error
    • +
    + +
    +
    + +
    +
    +
    +
      +
    • +
      + + + + dateDecodingStrategy + +
      +
      +
      +
      +
      +
      +

      The decoding strategy for Dates. +The variable can be defined within your QueryParams object and tells the QueryDecoder how dates should be decoded. The enum used for the DateDecodingStrategy is the same one found in the JSONDecoder.

      +

      Usage Example:

      +
      struct MyQuery: QueryParams {
      +   let date: Date
      +   static let dateDecodingStrategy: JSONDecoder.DateDecodingStrategy = .iso8601
      +   static let dateEncodingStrategy: JSONEncoder.DateEncodingStrategy = .iso8601
      +}
      +
      +let queryParams = ["date": "2019-09-06T10:14:41+0000"]
      +
      +let query = try QueryDecoder(dictionary: queryParams).decode(MyQuery.self)
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      static var dateDecodingStrategy: JSONDecoder.DateDecodingStrategy { get }
      + +
      +
      +
      +
      +
    • +
    • +
      + + + + dateEncodingStrategy + +
      +
      +
      +
      +
      +
      +

      The encoding strategy for Dates. + The variable would be defined within your QueryParams object and tells the QueryEncoder how dates should be encoded. The enum used for the DateEncodingStrategy is the same one found in the JSONEncoder. + ### Usage Example: ###

      +
       struct MyQuery: QueryParams {
      +    let date: Date
      +    static let dateDecodingStrategy: JSONDecoder.DateDecodingStrategy = .iso8601
      +    static let dateEncodingStrategy: JSONEncoder.DateEncodingStrategy = .iso8601
      + }
      +
      +let query = MyQuery(date: Date(timeIntervalSinceNow: 0))
      +
      +let myQueryDict: [String: String] = try QueryEncoder().encode(query)
      +
      + +
      +
      +

      Declaration

      +
      +

      Swift

      +
      static var dateEncodingStrategy: JSONEncoder.DateEncodingStrategy { get }
      + +
      +
      +
      +
      +
    • +
    +
    +
    +
    + +
    +
    + + + + diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs.html index 0ffcad6..2c81b9b 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs.html @@ -14,6 +14,7 @@ + @@ -22,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -86,6 +87,9 @@

  • + @@ -143,7 +147,7 @@ Operation @@ -290,7 +294,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public struct BodyFormat: Equatable
    +
    public struct BodyFormat : Equatable
    @@ -319,7 +323,7 @@

    Declaration

    Declaration

    Swift

    -
    public struct UnsupportedBodyFormatError: Error
    +
    public struct UnsupportedBodyFormatError : Error
    @@ -363,7 +367,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public struct RequestError: RawRepresentable, Equatable, Hashable, Comparable, Error, CustomStringConvertible
    +
    public struct RequestError : RawRepresentable, Equatable, Hashable, Comparable, Error, CustomStringConvertible
    @@ -396,7 +400,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public struct Ordering: Codable
    +
    public struct Ordering : Codable
    @@ -433,7 +437,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public struct Pagination: Codable
    +
    public struct Pagination : Codable
    @@ -475,7 +479,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public struct GreaterThan<I: Identifier>: Operation
    +
    public struct GreaterThan<I> : Operation where I : Identifier
    @@ -517,7 +521,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public struct GreaterThanOrEqual<I: Identifier>: Operation
    +
    public struct GreaterThanOrEqual<I> : Operation where I : Identifier
    @@ -560,7 +564,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public struct LowerThan<I: Identifier>: Operation
    +
    public struct LowerThan<I> : Operation where I : Identifier
    @@ -602,7 +606,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public struct LowerThanOrEqual<I: Identifier>: Operation
    +
    public struct LowerThanOrEqual<I> : Operation where I : Identifier
    @@ -644,7 +648,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public struct InclusiveRange<I: Identifier>: Operation
    +
    public struct InclusiveRange<I> : Operation where I : Identifier
    @@ -686,7 +690,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public struct ExclusiveRange<I: Identifier>: Operation
    +
    public struct ExclusiveRange<I> : Operation where I : Identifier
    @@ -701,8 +705,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/BodyFormat.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/BodyFormat.html index 46c3d29..015ce9c 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/BodyFormat.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/BodyFormat.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

    + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    BodyFormat

    -
    public struct BodyFormat: Equatable
    +
    public struct BodyFormat : Equatable
    @@ -306,9 +309,9 @@

    Declaration

  • - + - ==(_:_:) + ==(_:_:)
    @@ -323,7 +326,7 @@

    Declaration

    Declaration

    Swift

    -
    public static func == (_ lhs: BodyFormat, _ rhs: BodyFormat) -> Bool
    +
    public static func == (lhs: BodyFormat, rhs: BodyFormat) -> Bool
    @@ -350,7 +353,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let json = BodyFormat("application/json")
    +
    public static let json: BodyFormat
    @@ -365,8 +368,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/ExclusiveRange.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/ExclusiveRange.html index 9285f94..5062686 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/ExclusiveRange.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/ExclusiveRange.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    ExclusiveRange

    -
    public struct ExclusiveRange<I: Identifier>: Operation
    +
    public struct ExclusiveRange<I> : Operation where I : Identifier
    @@ -275,9 +278,9 @@

    Usage Example:

  • - + - init(start:end:) + init(start:end:)
    @@ -302,9 +305,9 @@

    Declaration

  • - + - init(string:) + init(string:)
    @@ -415,8 +418,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/GreaterThan.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/GreaterThan.html index 6669d8b..6dbc450 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/GreaterThan.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/GreaterThan.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    GreaterThan

    -
    public struct GreaterThan<I: Identifier>: Operation
    +
    public struct GreaterThan<I> : Operation where I : Identifier
    @@ -275,9 +278,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -302,9 +305,9 @@

    Declaration

  • - + - init(string:) + init(string:)
    @@ -415,8 +418,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/GreaterThanOrEqual.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/GreaterThanOrEqual.html index 08b7248..8b55665 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/GreaterThanOrEqual.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/GreaterThanOrEqual.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    GreaterThanOrEqual

    -
    public struct GreaterThanOrEqual<I: Identifier>: Operation
    +
    public struct GreaterThanOrEqual<I> : Operation where I : Identifier
    @@ -275,9 +278,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -302,9 +305,9 @@

    Declaration

  • - + - init(string:) + init(string:)
    @@ -415,8 +418,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/InclusiveRange.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/InclusiveRange.html index 220b4e2..a1568b2 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/InclusiveRange.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/InclusiveRange.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    InclusiveRange

    -
    public struct InclusiveRange<I: Identifier>: Operation
    +
    public struct InclusiveRange<I> : Operation where I : Identifier
    @@ -275,9 +278,9 @@

    Usage Example:

  • - + - init(start:end:) + init(start:end:)
    @@ -302,9 +305,9 @@

    Declaration

  • - + - init(string:) + init(string:)
    @@ -415,8 +418,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/LowerThan.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/LowerThan.html index f104d97..1966e91 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/LowerThan.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/LowerThan.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    LowerThan

    -
    public struct LowerThan<I: Identifier>: Operation
    +
    public struct LowerThan<I> : Operation where I : Identifier
    @@ -276,9 +279,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -303,9 +306,9 @@

    Declaration

  • - + - init(string:) + init(string:)
    @@ -416,8 +419,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/LowerThanOrEqual.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/LowerThanOrEqual.html index af9bf05..15b5b0c 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/LowerThanOrEqual.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/LowerThanOrEqual.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    LowerThanOrEqual

    -
    public struct LowerThanOrEqual<I: Identifier>: Operation
    +
    public struct LowerThanOrEqual<I> : Operation where I : Identifier
    @@ -275,9 +278,9 @@

    Usage Example:

  • - + - init(value:) + init(value:)
    @@ -302,9 +305,9 @@

    Declaration

  • - + - init(string:) + init(string:)
    @@ -415,8 +418,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/Ordering.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/Ordering.html index e99b3ce..d1321f8 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/Ordering.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/Ordering.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    Ordering

    -
    public struct Ordering: Codable
    +
    public struct Ordering : Codable
    @@ -266,9 +269,9 @@

    Usage Example:

  • - + - init(by:) + init(by:)
    @@ -293,9 +296,9 @@

    Declaration

  • - + - init(by:) + init(by:)
    @@ -352,8 +355,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/Pagination.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/Pagination.html index 169c289..75b285c 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/Pagination.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/Pagination.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    Pagination

    -
    public struct Pagination: Codable
    +
    public struct Pagination : Codable
    @@ -270,9 +273,9 @@

    Usage Example:

  • - + - init(start:size:) + init(start:size:)
    @@ -287,7 +290,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public init(start: Int  = 0, size: Int)
    +
    public init(start: Int = 0, size: Int)
    @@ -329,8 +332,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/RequestError.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/RequestError.html index 91dd82f..79c26d8 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/RequestError.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/RequestError.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    RequestError

    -
    public struct RequestError: RawRepresentable, Equatable, Hashable, Comparable, Error, CustomStringConvertible
    +
    public struct RequestError : RawRepresentable, Equatable, Hashable, Comparable, Error, CustomStringConvertible
    @@ -342,9 +345,9 @@

    Creating a RequestError from a numeric code

  • - + - init(rawValue:) + init(rawValue:)
    @@ -388,9 +391,9 @@

    Parameters

  • - + - init(rawValue:reason:) + init(rawValue:reason:)
    @@ -446,9 +449,9 @@

    Parameters

  • - + - init(_:body:) + init(_:body:)
    @@ -464,7 +467,7 @@

    Parameters

    Declaration

    Swift

    -
    public init<Body: Codable>(_ base: RequestError, body: Body)
    +
    public init<Body>(_ base: RequestError, body: Body) where Body : Decodable, Body : Encodable
    @@ -505,9 +508,9 @@

    Parameters

  • - + - init(_:bodyData:format:) + init(_:bodyData:format:)
    @@ -666,9 +669,9 @@

    Declaration

    • nil if there is no body
    • -
    • a (type-erased) Codable object if the error was initialized with init(_:body:)
    • +
    • a (type-erased) Codable object if the error was initialized with init(_:body:)
    • bytes of data and a signifier of the format in which they are stored (eg: JSON) -if the error was initialized with init(_:bodyData:format:)
    • +if the error was initialized with init(_:bodyData:format:)

    Usage example:

    if let errorBody = error.body {
    @@ -681,7 +684,7 @@ 

    Usage example:

    Note

    If you need a Codable representation and the body is data, you - can call the bodyAs(_:) function to get the converted value. + can call the bodyAs(_:) function to get the converted value.
    @@ -690,7 +693,7 @@

    Usage example:

    Declaration

    Swift

    -
    public private(set) var body: ErrorBody? = nil
    +
    public private(set) var body: RequestError.ErrorBody?
    @@ -700,9 +703,9 @@

    Declaration

  • - + - encodeBody(_:) + encodeBody(_:)
    @@ -713,7 +716,7 @@

    Declaration

    Returns the Codable error body encoded into bytes in a given format (eg: JSON).

    This function should be used if the RequestError was created using -init(_:body:), otherwise it will return nil.

    +init(_:body:), otherwise it will return nil.

    Note

    This function is primarily intended for use by the Kitura Router so @@ -774,7 +777,7 @@

    Parameters

    Return Value

    The Data object or nil if there is no body, or if the - error was not initialized with init(_:body:).

    + error was not initialized with init(_:body:).

    @@ -782,9 +785,9 @@

    Return Value

  • - + - decodeBody(_:) + decodeBody(_:)
    @@ -795,9 +798,9 @@

    Return Value

    Returns the Data error body as the requested Codable type.

    This function should be used if the RequestError was created using -init(_:bodyData:format:), otherwise it will return nil.

    +init(_:bodyData:format:), otherwise it will return nil.

    -

    This function throws; you can use bodyAs(_:) instead if you want +

    This function throws; you can use bodyAs(_:) instead if you want to ignore DecodingErrors.

    Note

    @@ -826,7 +829,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public func decodeBody<Body: Codable>(_ type: Body.Type) throws -> Body?
    +
    public func decodeBody<Body>(_ type: Body.Type) throws -> Body? where Body : Decodable, Body : Encodable
    @@ -853,7 +856,7 @@

    Parameters

    Return Value

    The Codable object or nil if there is no body or if the - error was not initialized with init(_:bodyData:format:).

    + error was not initialized with init(_:bodyData:format:).

    @@ -861,9 +864,9 @@

    Return Value

  • - + - bodyAs(_:) + bodyAs(_:)
    @@ -874,10 +877,10 @@

    Return Value

    Returns the Data error body as the requested Codable type.

    This function should be used if the RequestError was created using -init(_:bodyData:format:), otherwise it will return nil.

    +init(_:bodyData:format:), otherwise it will return nil.

    This function ignores DecodingErrors, and returns nil if decoding -fails. If you want DecodingErrors to be thrown, use decodeBody(_:) +fails. If you want DecodingErrors to be thrown, use decodeBody(_:) instead.

    Note

    @@ -897,7 +900,7 @@

    Usage Example:

    Declaration

    Swift

    -
    public func bodyAs<Body: Codable>(_ type: Body.Type) -> Body?
    +
    public func bodyAs<Body>(_ type: Body.Type) -> Body? where Body : Decodable, Body : Encodable
    @@ -924,7 +927,7 @@

    Parameters

    Return Value

    The Codable object or nil if there is no body, or if the - error was not initialized with init(_:bodyData:format:), or + error was not initialized with init(_:bodyData:format:), or if decoding fails.

    @@ -944,9 +947,9 @@

    Comparing RequestErrors

  • - + - <(_:_:) + <(_:_:)
    @@ -971,9 +974,9 @@

    Declaration

  • - + - ==(_:_:) + ==(_:_:)
    @@ -1026,7 +1029,7 @@

    Describing a RequestError

    Declaration

    Swift

    -
    public var description: String
    +
    public var description: String { get }
    @@ -1053,7 +1056,7 @@

    Declaration

    Declaration

    Swift

    -
    public var hashValue: Int
    +
    public var hashValue: Int { get }
    @@ -1087,7 +1090,7 @@

    Declaration

    Declaration

    Swift

    -
    public var httpCode: Int
    +
    public var httpCode: Int { get }
    @@ -1097,9 +1100,9 @@

    Declaration

  • - + - init(httpCode:) + init(httpCode:)
    @@ -1171,7 +1174,7 @@

    Accessing constants representing HTTP status codes

    Declaration

    Swift

    -
    public static let `continue` = RequestError(httpCode: 100)
    +
    public static let `continue`: RequestError
    @@ -1198,7 +1201,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let switchingProtocols = RequestError(httpCode: 101)
    +
    public static let switchingProtocols: RequestError
    @@ -1225,7 +1228,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let ok = RequestError(httpCode: 200)
    +
    public static let ok: RequestError
    @@ -1252,7 +1255,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let created = RequestError(httpCode: 201)
    +
    public static let created: RequestError
    @@ -1279,7 +1282,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let accepted = RequestError(httpCode: 202)
    +
    public static let accepted: RequestError
    @@ -1306,7 +1309,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let nonAuthoritativeInformation = RequestError(httpCode: 203)
    +
    public static let nonAuthoritativeInformation: RequestError
    @@ -1333,7 +1336,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let noContent = RequestError(httpCode: 204)
    +
    public static let noContent: RequestError
    @@ -1360,7 +1363,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let resetContent = RequestError(httpCode: 205)
    +
    public static let resetContent: RequestError
    @@ -1387,7 +1390,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let partialContent = RequestError(httpCode: 206)
    +
    public static let partialContent: RequestError
    @@ -1414,7 +1417,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let multiStatus = RequestError(httpCode: 207)
    +
    public static let multiStatus: RequestError
    @@ -1441,7 +1444,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let alreadyReported = RequestError(httpCode: 208)
    +
    public static let alreadyReported: RequestError
    @@ -1468,7 +1471,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let imUsed = RequestError(httpCode: 226)
    +
    public static let imUsed: RequestError
    @@ -1495,7 +1498,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let multipleChoices = RequestError(httpCode: 300)
    +
    public static let multipleChoices: RequestError
    @@ -1522,7 +1525,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let movedPermanently = RequestError(httpCode: 301)
    +
    public static let movedPermanently: RequestError
    @@ -1549,7 +1552,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let found = RequestError(httpCode: 302)
    +
    public static let found: RequestError
    @@ -1576,7 +1579,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let seeOther = RequestError(httpCode: 303)
    +
    public static let seeOther: RequestError
    @@ -1603,7 +1606,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let notModified = RequestError(httpCode: 304)
    +
    public static let notModified: RequestError
    @@ -1630,7 +1633,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let useProxy = RequestError(httpCode: 305)
    +
    public static let useProxy: RequestError
    @@ -1657,7 +1660,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let temporaryRedirect = RequestError(httpCode: 307)
    +
    public static let temporaryRedirect: RequestError
    @@ -1684,7 +1687,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let permanentRedirect = RequestError(httpCode: 308)
    +
    public static let permanentRedirect: RequestError
    @@ -1711,7 +1714,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let badRequest = RequestError(httpCode: 400)
    +
    public static let badRequest: RequestError
    @@ -1738,7 +1741,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let unauthorized = RequestError(httpCode: 401)
    +
    public static let unauthorized: RequestError
    @@ -1765,7 +1768,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let paymentRequired = RequestError(httpCode: 402)
    +
    public static let paymentRequired: RequestError
    @@ -1792,7 +1795,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let forbidden = RequestError(httpCode: 403)
    +
    public static let forbidden: RequestError
    @@ -1819,7 +1822,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let notFound = RequestError(httpCode: 404)
    +
    public static let notFound: RequestError
    @@ -1846,7 +1849,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let methodNotAllowed = RequestError(httpCode: 405)
    +
    public static let methodNotAllowed: RequestError
    @@ -1873,7 +1876,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let notAcceptable = RequestError(httpCode: 406)
    +
    public static let notAcceptable: RequestError
    @@ -1900,7 +1903,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let proxyAuthenticationRequired = RequestError(httpCode: 407)
    +
    public static let proxyAuthenticationRequired: RequestError
    @@ -1927,7 +1930,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let requestTimeout = RequestError(httpCode: 408)
    +
    public static let requestTimeout: RequestError
    @@ -1954,7 +1957,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let conflict = RequestError(httpCode: 409)
    +
    public static let conflict: RequestError
    @@ -1981,7 +1984,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let gone = RequestError(httpCode: 410)
    +
    public static let gone: RequestError
    @@ -2008,7 +2011,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let lengthRequired = RequestError(httpCode: 411)
    +
    public static let lengthRequired: RequestError
    @@ -2035,7 +2038,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let preconditionFailed = RequestError(httpCode: 412)
    +
    public static let preconditionFailed: RequestError
    @@ -2062,7 +2065,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let payloadTooLarge = RequestError(httpCode: 413)
    +
    public static let payloadTooLarge: RequestError
    @@ -2089,7 +2092,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let uriTooLong = RequestError(httpCode: 414)
    +
    public static let uriTooLong: RequestError
    @@ -2116,7 +2119,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let unsupportedMediaType = RequestError(httpCode: 415)
    +
    public static let unsupportedMediaType: RequestError
    @@ -2143,7 +2146,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let rangeNotSatisfiable = RequestError(httpCode: 416)
    +
    public static let rangeNotSatisfiable: RequestError
    @@ -2170,7 +2173,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let expectationFailed = RequestError(httpCode: 417)
    +
    public static let expectationFailed: RequestError
    @@ -2197,7 +2200,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let misdirectedRequest = RequestError(httpCode: 421)
    +
    public static let misdirectedRequest: RequestError
    @@ -2224,7 +2227,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let unprocessableEntity = RequestError(httpCode: 422)
    +
    public static let unprocessableEntity: RequestError
    @@ -2251,7 +2254,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let locked = RequestError(httpCode: 423)
    +
    public static let locked: RequestError
    @@ -2278,7 +2281,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let failedDependency = RequestError(httpCode: 424)
    +
    public static let failedDependency: RequestError
    @@ -2305,7 +2308,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let upgradeRequired = RequestError(httpCode: 426)
    +
    public static let upgradeRequired: RequestError
    @@ -2332,7 +2335,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let preconditionRequired = RequestError(httpCode: 428)
    +
    public static let preconditionRequired: RequestError
    @@ -2359,7 +2362,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let tooManyRequests = RequestError(httpCode: 429)
    +
    public static let tooManyRequests: RequestError
    @@ -2386,7 +2389,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let requestHeaderFieldsTooLarge = RequestError(httpCode: 431)
    +
    public static let requestHeaderFieldsTooLarge: RequestError
    @@ -2413,7 +2416,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let unavailableForLegalReasons = RequestError(httpCode: 451)
    +
    public static let unavailableForLegalReasons: RequestError
    @@ -2440,7 +2443,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let internalServerError = RequestError(httpCode: 500)
    +
    public static let internalServerError: RequestError
    @@ -2467,7 +2470,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let notImplemented = RequestError(httpCode: 501)
    +
    public static let notImplemented: RequestError
    @@ -2494,7 +2497,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let badGateway = RequestError(httpCode: 502)
    +
    public static let badGateway: RequestError
    @@ -2521,7 +2524,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let serviceUnavailable = RequestError(httpCode: 503)
    +
    public static let serviceUnavailable: RequestError
    @@ -2548,7 +2551,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let gatewayTimeout = RequestError(httpCode: 504)
    +
    public static let gatewayTimeout: RequestError
    @@ -2575,7 +2578,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let httpVersionNotSupported = RequestError(httpCode: 505)
    +
    public static let httpVersionNotSupported: RequestError
    @@ -2602,7 +2605,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let variantAlsoNegotiates = RequestError(httpCode: 506)
    +
    public static let variantAlsoNegotiates: RequestError
    @@ -2629,7 +2632,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let insufficientStorage = RequestError(httpCode: 507)
    +
    public static let insufficientStorage: RequestError
    @@ -2656,7 +2659,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let loopDetected = RequestError(httpCode: 508)
    +
    public static let loopDetected: RequestError
    @@ -2683,7 +2686,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let notExtended = RequestError(httpCode: 510)
    +
    public static let notExtended: RequestError
    @@ -2710,7 +2713,7 @@

    Declaration

    Declaration

    Swift

    -
    public static let networkAuthenticationRequired = RequestError(httpCode: 511)
    +
    public static let networkAuthenticationRequired: RequestError
    @@ -2725,8 +2728,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/RequestError/ErrorBody.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/RequestError/ErrorBody.html index 73da0df..7926180 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/RequestError/ErrorBody.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/RequestError/ErrorBody.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

  • + @@ -144,7 +147,7 @@ Operation @@ -262,9 +265,9 @@

    ErrorBody

  • - - - codable + + + codable(_:)
    @@ -286,16 +289,12 @@

    Declaration

  • - - -
    -
    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/UnsupportedBodyFormatError.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/UnsupportedBodyFormatError.html index fdd6c5b..3943bbc 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/UnsupportedBodyFormatError.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Structs/UnsupportedBodyFormatError.html @@ -23,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -87,6 +87,9 @@

    + @@ -144,7 +147,7 @@ Operation @@ -245,7 +248,7 @@

    UnsupportedBodyFormatError

    -
    public struct UnsupportedBodyFormatError: Error
    +
    public struct UnsupportedBodyFormatError : Error
    @@ -289,9 +292,9 @@

    Declaration

  • - + - init(_:) + init(_:)
    @@ -321,8 +324,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Typealiases.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Typealiases.html index 8a51f21..1e0c012 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Typealiases.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/Typealiases.html @@ -14,6 +14,7 @@ + @@ -22,7 +23,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -86,6 +87,9 @@

  • + @@ -143,7 +147,7 @@ Operation @@ -317,7 +321,7 @@

    Declaration

    Declaration

    Swift

    -
    public typealias CodableResultClosure<O: Codable> = (O?, RequestError?) -> Void
    +
    public typealias CodableResultClosure<O> = (O?, RequestError?) -> Void where O : Decodable, O : Encodable
    @@ -348,7 +352,7 @@

    Declaration

    Declaration

    Swift

    -
    public typealias CodableArrayResultClosure<O: Codable> = ([O]?, RequestError?) -> Void
    +
    public typealias CodableArrayResultClosure<O> = ([O]?, RequestError?) -> Void where O : Decodable, O : Encodable
    @@ -379,7 +383,7 @@

    Declaration

    Declaration

    Swift

    -
    public typealias IdentifierCodableArrayResultClosure<Id: Identifier, O: Codable> = ([(Id, O)]?, RequestError?) -> Void
    +
    public typealias IdentifierCodableArrayResultClosure<Id, O> = ([(Id, O)]?, RequestError?) -> Void where Id : Identifier, O : Decodable, O : Encodable
    @@ -410,7 +414,7 @@

    Declaration

    Declaration

    Swift

    -
    public typealias IdentifierCodableResultClosure<Id: Identifier, O: Codable> = (Id?, O?, RequestError?) -> Void
    +
    public typealias IdentifierCodableResultClosure<Id, O> = (Id?, O?, RequestError?) -> Void where Id : Identifier, O : Decodable, O : Encodable
    @@ -802,8 +806,8 @@

    Declaration

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/css/jazzy.css b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/css/jazzy.css index c83db5b..24cfe4a 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/css/jazzy.css +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/css/jazzy.css @@ -63,6 +63,10 @@ a { a:hover, a:focus { outline: 0; text-decoration: underline; } + a.discouraged { + text-decoration: line-through; } + a.discouraged:hover, a.discouraged:focus { + text-decoration: underline line-through; } table { background: #fff; @@ -225,7 +229,7 @@ pre code { .item a[name]:before { content: ""; display: block; } - .item .token { + .item .token, .item .direct-link { padding-left: 3px; margin-left: 0px; font-size: 1rem; } @@ -287,9 +291,9 @@ pre code { .language .aside-title { color: #4183c4; } -.aside-warning { +.aside-warning, .aside-deprecated, .aside-unavailable { border-left: 5px solid #ff6666; } - .aside-warning .aside-title { + .aside-warning .aside-title, .aside-deprecated .aside-title, .aside-unavailable .aside-title { color: #ff0000; } .graybox { diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/index.html b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/index.html index 5af23f3..2a9f0cc 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/index.html +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/index.html @@ -22,7 +22,7 @@ KituraContracts Docs - (100% documented) + (99% documented)

    @@ -86,6 +86,9 @@

    + @@ -143,7 +146,7 @@ Operation @@ -319,8 +322,8 @@

    License

    diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/js/jazzy.js b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/js/jazzy.js index 009c80d..e2b491d 100755 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/js/jazzy.js +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/js/jazzy.js @@ -35,9 +35,3 @@ $(".token").click(function(event) { } event.preventDefault(); }); - -// Dumb down quotes within code blocks that delimit strings instead of quotations -// https://github.com/realm/jazzy/issues/714 -$("code q").replaceWith(function () { - return ["\"", $(this).contents(), "\""]; -}); diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/js/jazzy.search.js b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/js/jazzy.search.js index 54be83c..e3d1ab9 100644 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/js/jazzy.search.js +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/js/jazzy.search.js @@ -1,9 +1,4 @@ $(function(){ - var searchIndex = lunr(function() { - this.ref('url'); - this.field('name'); - }); - var $typeahead = $('[data-typeahead]'); var $form = $typeahead.parents('form'); var searchURL = $form.attr('action'); @@ -26,21 +21,34 @@ $(function(){ $form.addClass('loading'); $.getJSON(searchURL).then(function(searchData) { - $.each(searchData, function (url, doc) { - searchIndex.add({url: url, name: doc.name}); + const searchIndex = lunr(function() { + this.ref('url'); + this.field('name'); + this.field('abstract'); + for (const [url, doc] of Object.entries(searchData)) { + this.add({url: url, name: doc.name, abstract: doc.abstract}); + } }); $typeahead.typeahead( { highlight: true, - minLength: 3 + minLength: 3, + autoselect: true }, { limit: 10, display: displayTemplate, templates: { suggestion: suggestionTemplate }, source: function(query, sync) { - var results = searchIndex.search(query).map(function(result) { + const lcSearch = query.toLowerCase(); + const results = searchIndex.query(function(q) { + q.term(lcSearch, { boost: 100 }); + q.term(lcSearch, { + boost: 10, + wildcard: lunr.Query.wildcard.TRAILING + }); + }).map(function(result) { var doc = searchData[result.ref]; doc.url = result.ref; return doc; diff --git a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/js/jquery.min.js b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/js/jquery.min.js index ab28a24..4d9b3a2 100755 --- a/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/js/jquery.min.js +++ b/docs/docsets/KituraContracts.docset/Contents/Resources/Documents/js/jquery.min.js @@ -1,4 +1,2 @@ -/*! jQuery v1.11.1 | (c) 2005, 2014 jQuery Foundation, Inc. | jquery.org/license */ -!function(a,b){"object"==typeof module&&"object"==typeof module.exports?module.exports=a.document?b(a,!0):function(a){if(!a.document)throw new Error("jQuery requires a window with a document");return b(a)}:b(a)}("undefined"!=typeof window?window:this,function(a,b){var c=[],d=c.slice,e=c.concat,f=c.push,g=c.indexOf,h={},i=h.toString,j=h.hasOwnProperty,k={},l="1.11.1",m=function(a,b){return new m.fn.init(a,b)},n=/^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g,o=/^-ms-/,p=/-([\da-z])/gi,q=function(a,b){return b.toUpperCase()};m.fn=m.prototype={jquery:l,constructor:m,selector:"",length:0,toArray:function(){return d.call(this)},get:function(a){return null!=a?0>a?this[a+this.length]:this[a]:d.call(this)},pushStack:function(a){var b=m.merge(this.constructor(),a);return b.prevObject=this,b.context=this.context,b},each:function(a,b){return m.each(this,a,b)},map:function(a){return this.pushStack(m.map(this,function(b,c){return a.call(b,c,b)}))},slice:function(){return this.pushStack(d.apply(this,arguments))},first:function(){return this.eq(0)},last:function(){return this.eq(-1)},eq:function(a){var b=this.length,c=+a+(0>a?b:0);return this.pushStack(c>=0&&b>c?[this[c]]:[])},end:function(){return this.prevObject||this.constructor(null)},push:f,sort:c.sort,splice:c.splice},m.extend=m.fn.extend=function(){var a,b,c,d,e,f,g=arguments[0]||{},h=1,i=arguments.length,j=!1;for("boolean"==typeof g&&(j=g,g=arguments[h]||{},h++),"object"==typeof g||m.isFunction(g)||(g={}),h===i&&(g=this,h--);i>h;h++)if(null!=(e=arguments[h]))for(d in e)a=g[d],c=e[d],g!==c&&(j&&c&&(m.isPlainObject(c)||(b=m.isArray(c)))?(b?(b=!1,f=a&&m.isArray(a)?a:[]):f=a&&m.isPlainObject(a)?a:{},g[d]=m.extend(j,f,c)):void 0!==c&&(g[d]=c));return g},m.extend({expando:"jQuery"+(l+Math.random()).replace(/\D/g,""),isReady:!0,error:function(a){throw new Error(a)},noop:function(){},isFunction:function(a){return"function"===m.type(a)},isArray:Array.isArray||function(a){return"array"===m.type(a)},isWindow:function(a){return null!=a&&a==a.window},isNumeric:function(a){return!m.isArray(a)&&a-parseFloat(a)>=0},isEmptyObject:function(a){var b;for(b in a)return!1;return!0},isPlainObject:function(a){var b;if(!a||"object"!==m.type(a)||a.nodeType||m.isWindow(a))return!1;try{if(a.constructor&&!j.call(a,"constructor")&&!j.call(a.constructor.prototype,"isPrototypeOf"))return!1}catch(c){return!1}if(k.ownLast)for(b in a)return j.call(a,b);for(b in a);return void 0===b||j.call(a,b)},type:function(a){return null==a?a+"":"object"==typeof a||"function"==typeof a?h[i.call(a)]||"object":typeof a},globalEval:function(b){b&&m.trim(b)&&(a.execScript||function(b){a.eval.call(a,b)})(b)},camelCase:function(a){return a.replace(o,"ms-").replace(p,q)},nodeName:function(a,b){return a.nodeName&&a.nodeName.toLowerCase()===b.toLowerCase()},each:function(a,b,c){var d,e=0,f=a.length,g=r(a);if(c){if(g){for(;f>e;e++)if(d=b.apply(a[e],c),d===!1)break}else for(e in a)if(d=b.apply(a[e],c),d===!1)break}else if(g){for(;f>e;e++)if(d=b.call(a[e],e,a[e]),d===!1)break}else for(e in a)if(d=b.call(a[e],e,a[e]),d===!1)break;return a},trim:function(a){return null==a?"":(a+"").replace(n,"")},makeArray:function(a,b){var c=b||[];return null!=a&&(r(Object(a))?m.merge(c,"string"==typeof a?[a]:a):f.call(c,a)),c},inArray:function(a,b,c){var d;if(b){if(g)return g.call(b,a,c);for(d=b.length,c=c?0>c?Math.max(0,d+c):c:0;d>c;c++)if(c in b&&b[c]===a)return c}return-1},merge:function(a,b){var c=+b.length,d=0,e=a.length;while(c>d)a[e++]=b[d++];if(c!==c)while(void 0!==b[d])a[e++]=b[d++];return a.length=e,a},grep:function(a,b,c){for(var d,e=[],f=0,g=a.length,h=!c;g>f;f++)d=!b(a[f],f),d!==h&&e.push(a[f]);return e},map:function(a,b,c){var d,f=0,g=a.length,h=r(a),i=[];if(h)for(;g>f;f++)d=b(a[f],f,c),null!=d&&i.push(d);else for(f in a)d=b(a[f],f,c),null!=d&&i.push(d);return e.apply([],i)},guid:1,proxy:function(a,b){var c,e,f;return"string"==typeof b&&(f=a[b],b=a,a=f),m.isFunction(a)?(c=d.call(arguments,2),e=function(){return a.apply(b||this,c.concat(d.call(arguments)))},e.guid=a.guid=a.guid||m.guid++,e):void 0},now:function(){return+new Date},support:k}),m.each("Boolean Number String Function Array Date RegExp Object Error".split(" "),function(a,b){h["[object "+b+"]"]=b.toLowerCase()});function r(a){var b=a.length,c=m.type(a);return"function"===c||m.isWindow(a)?!1:1===a.nodeType&&b?!0:"array"===c||0===b||"number"==typeof b&&b>0&&b-1 in a}var s=function(a){var b,c,d,e,f,g,h,i,j,k,l,m,n,o,p,q,r,s,t,u="sizzle"+-new Date,v=a.document,w=0,x=0,y=gb(),z=gb(),A=gb(),B=function(a,b){return a===b&&(l=!0),0},C="undefined",D=1<<31,E={}.hasOwnProperty,F=[],G=F.pop,H=F.push,I=F.push,J=F.slice,K=F.indexOf||function(a){for(var b=0,c=this.length;c>b;b++)if(this[b]===a)return b;return-1},L="checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped",M="[\\x20\\t\\r\\n\\f]",N="(?:\\\\.|[\\w-]|[^\\x00-\\xa0])+",O=N.replace("w","w#"),P="\\["+M+"*("+N+")(?:"+M+"*([*^$|!~]?=)"+M+"*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|("+O+"))|)"+M+"*\\]",Q=":("+N+")(?:\\((('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|((?:\\\\.|[^\\\\()[\\]]|"+P+")*)|.*)\\)|)",R=new RegExp("^"+M+"+|((?:^|[^\\\\])(?:\\\\.)*)"+M+"+$","g"),S=new RegExp("^"+M+"*,"+M+"*"),T=new RegExp("^"+M+"*([>+~]|"+M+")"+M+"*"),U=new RegExp("="+M+"*([^\\]'\"]*?)"+M+"*\\]","g"),V=new RegExp(Q),W=new RegExp("^"+O+"$"),X={ID:new RegExp("^#("+N+")"),CLASS:new RegExp("^\\.("+N+")"),TAG:new RegExp("^("+N.replace("w","w*")+")"),ATTR:new RegExp("^"+P),PSEUDO:new RegExp("^"+Q),CHILD:new RegExp("^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\("+M+"*(even|odd|(([+-]|)(\\d*)n|)"+M+"*(?:([+-]|)"+M+"*(\\d+)|))"+M+"*\\)|)","i"),bool:new RegExp("^(?:"+L+")$","i"),needsContext:new RegExp("^"+M+"*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\("+M+"*((?:-\\d)?\\d*)"+M+"*\\)|)(?=[^-]|$)","i")},Y=/^(?:input|select|textarea|button)$/i,Z=/^h\d$/i,$=/^[^{]+\{\s*\[native \w/,_=/^(?:#([\w-]+)|(\w+)|\.([\w-]+))$/,ab=/[+~]/,bb=/'|\\/g,cb=new RegExp("\\\\([\\da-f]{1,6}"+M+"?|("+M+")|.)","ig"),db=function(a,b,c){var d="0x"+b-65536;return d!==d||c?b:0>d?String.fromCharCode(d+65536):String.fromCharCode(d>>10|55296,1023&d|56320)};try{I.apply(F=J.call(v.childNodes),v.childNodes),F[v.childNodes.length].nodeType}catch(eb){I={apply:F.length?function(a,b){H.apply(a,J.call(b))}:function(a,b){var c=a.length,d=0;while(a[c++]=b[d++]);a.length=c-1}}}function fb(a,b,d,e){var f,h,j,k,l,o,r,s,w,x;if((b?b.ownerDocument||b:v)!==n&&m(b),b=b||n,d=d||[],!a||"string"!=typeof a)return d;if(1!==(k=b.nodeType)&&9!==k)return[];if(p&&!e){if(f=_.exec(a))if(j=f[1]){if(9===k){if(h=b.getElementById(j),!h||!h.parentNode)return d;if(h.id===j)return d.push(h),d}else if(b.ownerDocument&&(h=b.ownerDocument.getElementById(j))&&t(b,h)&&h.id===j)return d.push(h),d}else{if(f[2])return I.apply(d,b.getElementsByTagName(a)),d;if((j=f[3])&&c.getElementsByClassName&&b.getElementsByClassName)return I.apply(d,b.getElementsByClassName(j)),d}if(c.qsa&&(!q||!q.test(a))){if(s=r=u,w=b,x=9===k&&a,1===k&&"object"!==b.nodeName.toLowerCase()){o=g(a),(r=b.getAttribute("id"))?s=r.replace(bb,"\\$&"):b.setAttribute("id",s),s="[id='"+s+"'] ",l=o.length;while(l--)o[l]=s+qb(o[l]);w=ab.test(a)&&ob(b.parentNode)||b,x=o.join(",")}if(x)try{return I.apply(d,w.querySelectorAll(x)),d}catch(y){}finally{r||b.removeAttribute("id")}}}return i(a.replace(R,"$1"),b,d,e)}function gb(){var a=[];function b(c,e){return a.push(c+" ")>d.cacheLength&&delete b[a.shift()],b[c+" "]=e}return b}function hb(a){return a[u]=!0,a}function ib(a){var b=n.createElement("div");try{return!!a(b)}catch(c){return!1}finally{b.parentNode&&b.parentNode.removeChild(b),b=null}}function jb(a,b){var c=a.split("|"),e=a.length;while(e--)d.attrHandle[c[e]]=b}function kb(a,b){var c=b&&a,d=c&&1===a.nodeType&&1===b.nodeType&&(~b.sourceIndex||D)-(~a.sourceIndex||D);if(d)return d;if(c)while(c=c.nextSibling)if(c===b)return-1;return a?1:-1}function lb(a){return function(b){var c=b.nodeName.toLowerCase();return"input"===c&&b.type===a}}function mb(a){return function(b){var c=b.nodeName.toLowerCase();return("input"===c||"button"===c)&&b.type===a}}function nb(a){return hb(function(b){return b=+b,hb(function(c,d){var e,f=a([],c.length,b),g=f.length;while(g--)c[e=f[g]]&&(c[e]=!(d[e]=c[e]))})})}function ob(a){return a&&typeof a.getElementsByTagName!==C&&a}c=fb.support={},f=fb.isXML=function(a){var b=a&&(a.ownerDocument||a).documentElement;return b?"HTML"!==b.nodeName:!1},m=fb.setDocument=function(a){var b,e=a?a.ownerDocument||a:v,g=e.defaultView;return e!==n&&9===e.nodeType&&e.documentElement?(n=e,o=e.documentElement,p=!f(e),g&&g!==g.top&&(g.addEventListener?g.addEventListener("unload",function(){m()},!1):g.attachEvent&&g.attachEvent("onunload",function(){m()})),c.attributes=ib(function(a){return a.className="i",!a.getAttribute("className")}),c.getElementsByTagName=ib(function(a){return a.appendChild(e.createComment("")),!a.getElementsByTagName("*").length}),c.getElementsByClassName=$.test(e.getElementsByClassName)&&ib(function(a){return a.innerHTML="
    ",a.firstChild.className="i",2===a.getElementsByClassName("i").length}),c.getById=ib(function(a){return o.appendChild(a).id=u,!e.getElementsByName||!e.getElementsByName(u).length}),c.getById?(d.find.ID=function(a,b){if(typeof b.getElementById!==C&&p){var c=b.getElementById(a);return c&&c.parentNode?[c]:[]}},d.filter.ID=function(a){var b=a.replace(cb,db);return function(a){return a.getAttribute("id")===b}}):(delete d.find.ID,d.filter.ID=function(a){var b=a.replace(cb,db);return function(a){var c=typeof a.getAttributeNode!==C&&a.getAttributeNode("id");return c&&c.value===b}}),d.find.TAG=c.getElementsByTagName?function(a,b){return typeof b.getElementsByTagName!==C?b.getElementsByTagName(a):void 0}:function(a,b){var c,d=[],e=0,f=b.getElementsByTagName(a);if("*"===a){while(c=f[e++])1===c.nodeType&&d.push(c);return d}return f},d.find.CLASS=c.getElementsByClassName&&function(a,b){return typeof b.getElementsByClassName!==C&&p?b.getElementsByClassName(a):void 0},r=[],q=[],(c.qsa=$.test(e.querySelectorAll))&&(ib(function(a){a.innerHTML="",a.querySelectorAll("[msallowclip^='']").length&&q.push("[*^$]="+M+"*(?:''|\"\")"),a.querySelectorAll("[selected]").length||q.push("\\["+M+"*(?:value|"+L+")"),a.querySelectorAll(":checked").length||q.push(":checked")}),ib(function(a){var b=e.createElement("input");b.setAttribute("type","hidden"),a.appendChild(b).setAttribute("name","D"),a.querySelectorAll("[name=d]").length&&q.push("name"+M+"*[*^$|!~]?="),a.querySelectorAll(":enabled").length||q.push(":enabled",":disabled"),a.querySelectorAll("*,:x"),q.push(",.*:")})),(c.matchesSelector=$.test(s=o.matches||o.webkitMatchesSelector||o.mozMatchesSelector||o.oMatchesSelector||o.msMatchesSelector))&&ib(function(a){c.disconnectedMatch=s.call(a,"div"),s.call(a,"[s!='']:x"),r.push("!=",Q)}),q=q.length&&new RegExp(q.join("|")),r=r.length&&new RegExp(r.join("|")),b=$.test(o.compareDocumentPosition),t=b||$.test(o.contains)?function(a,b){var c=9===a.nodeType?a.documentElement:a,d=b&&b.parentNode;return a===d||!(!d||1!==d.nodeType||!(c.contains?c.contains(d):a.compareDocumentPosition&&16&a.compareDocumentPosition(d)))}:function(a,b){if(b)while(b=b.parentNode)if(b===a)return!0;return!1},B=b?function(a,b){if(a===b)return l=!0,0;var d=!a.compareDocumentPosition-!b.compareDocumentPosition;return d?d:(d=(a.ownerDocument||a)===(b.ownerDocument||b)?a.compareDocumentPosition(b):1,1&d||!c.sortDetached&&b.compareDocumentPosition(a)===d?a===e||a.ownerDocument===v&&t(v,a)?-1:b===e||b.ownerDocument===v&&t(v,b)?1:k?K.call(k,a)-K.call(k,b):0:4&d?-1:1)}:function(a,b){if(a===b)return l=!0,0;var c,d=0,f=a.parentNode,g=b.parentNode,h=[a],i=[b];if(!f||!g)return a===e?-1:b===e?1:f?-1:g?1:k?K.call(k,a)-K.call(k,b):0;if(f===g)return kb(a,b);c=a;while(c=c.parentNode)h.unshift(c);c=b;while(c=c.parentNode)i.unshift(c);while(h[d]===i[d])d++;return d?kb(h[d],i[d]):h[d]===v?-1:i[d]===v?1:0},e):n},fb.matches=function(a,b){return fb(a,null,null,b)},fb.matchesSelector=function(a,b){if((a.ownerDocument||a)!==n&&m(a),b=b.replace(U,"='$1']"),!(!c.matchesSelector||!p||r&&r.test(b)||q&&q.test(b)))try{var d=s.call(a,b);if(d||c.disconnectedMatch||a.document&&11!==a.document.nodeType)return d}catch(e){}return fb(b,n,null,[a]).length>0},fb.contains=function(a,b){return(a.ownerDocument||a)!==n&&m(a),t(a,b)},fb.attr=function(a,b){(a.ownerDocument||a)!==n&&m(a);var e=d.attrHandle[b.toLowerCase()],f=e&&E.call(d.attrHandle,b.toLowerCase())?e(a,b,!p):void 0;return void 0!==f?f:c.attributes||!p?a.getAttribute(b):(f=a.getAttributeNode(b))&&f.specified?f.value:null},fb.error=function(a){throw new Error("Syntax error, unrecognized expression: "+a)},fb.uniqueSort=function(a){var b,d=[],e=0,f=0;if(l=!c.detectDuplicates,k=!c.sortStable&&a.slice(0),a.sort(B),l){while(b=a[f++])b===a[f]&&(e=d.push(f));while(e--)a.splice(d[e],1)}return k=null,a},e=fb.getText=function(a){var b,c="",d=0,f=a.nodeType;if(f){if(1===f||9===f||11===f){if("string"==typeof a.textContent)return a.textContent;for(a=a.firstChild;a;a=a.nextSibling)c+=e(a)}else if(3===f||4===f)return a.nodeValue}else while(b=a[d++])c+=e(b);return c},d=fb.selectors={cacheLength:50,createPseudo:hb,match:X,attrHandle:{},find:{},relative:{">":{dir:"parentNode",first:!0}," ":{dir:"parentNode"},"+":{dir:"previousSibling",first:!0},"~":{dir:"previousSibling"}},preFilter:{ATTR:function(a){return a[1]=a[1].replace(cb,db),a[3]=(a[3]||a[4]||a[5]||"").replace(cb,db),"~="===a[2]&&(a[3]=" "+a[3]+" "),a.slice(0,4)},CHILD:function(a){return a[1]=a[1].toLowerCase(),"nth"===a[1].slice(0,3)?(a[3]||fb.error(a[0]),a[4]=+(a[4]?a[5]+(a[6]||1):2*("even"===a[3]||"odd"===a[3])),a[5]=+(a[7]+a[8]||"odd"===a[3])):a[3]&&fb.error(a[0]),a},PSEUDO:function(a){var b,c=!a[6]&&a[2];return X.CHILD.test(a[0])?null:(a[3]?a[2]=a[4]||a[5]||"":c&&V.test(c)&&(b=g(c,!0))&&(b=c.indexOf(")",c.length-b)-c.length)&&(a[0]=a[0].slice(0,b),a[2]=c.slice(0,b)),a.slice(0,3))}},filter:{TAG:function(a){var b=a.replace(cb,db).toLowerCase();return"*"===a?function(){return!0}:function(a){return a.nodeName&&a.nodeName.toLowerCase()===b}},CLASS:function(a){var b=y[a+" "];return b||(b=new RegExp("(^|"+M+")"+a+"("+M+"|$)"))&&y(a,function(a){return b.test("string"==typeof a.className&&a.className||typeof a.getAttribute!==C&&a.getAttribute("class")||"")})},ATTR:function(a,b,c){return function(d){var e=fb.attr(d,a);return null==e?"!="===b:b?(e+="","="===b?e===c:"!="===b?e!==c:"^="===b?c&&0===e.indexOf(c):"*="===b?c&&e.indexOf(c)>-1:"$="===b?c&&e.slice(-c.length)===c:"~="===b?(" "+e+" ").indexOf(c)>-1:"|="===b?e===c||e.slice(0,c.length+1)===c+"-":!1):!0}},CHILD:function(a,b,c,d,e){var f="nth"!==a.slice(0,3),g="last"!==a.slice(-4),h="of-type"===b;return 1===d&&0===e?function(a){return!!a.parentNode}:function(b,c,i){var j,k,l,m,n,o,p=f!==g?"nextSibling":"previousSibling",q=b.parentNode,r=h&&b.nodeName.toLowerCase(),s=!i&&!h;if(q){if(f){while(p){l=b;while(l=l[p])if(h?l.nodeName.toLowerCase()===r:1===l.nodeType)return!1;o=p="only"===a&&!o&&"nextSibling"}return!0}if(o=[g?q.firstChild:q.lastChild],g&&s){k=q[u]||(q[u]={}),j=k[a]||[],n=j[0]===w&&j[1],m=j[0]===w&&j[2],l=n&&q.childNodes[n];while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if(1===l.nodeType&&++m&&l===b){k[a]=[w,n,m];break}}else if(s&&(j=(b[u]||(b[u]={}))[a])&&j[0]===w)m=j[1];else while(l=++n&&l&&l[p]||(m=n=0)||o.pop())if((h?l.nodeName.toLowerCase()===r:1===l.nodeType)&&++m&&(s&&((l[u]||(l[u]={}))[a]=[w,m]),l===b))break;return m-=e,m===d||m%d===0&&m/d>=0}}},PSEUDO:function(a,b){var c,e=d.pseudos[a]||d.setFilters[a.toLowerCase()]||fb.error("unsupported pseudo: "+a);return e[u]?e(b):e.length>1?(c=[a,a,"",b],d.setFilters.hasOwnProperty(a.toLowerCase())?hb(function(a,c){var d,f=e(a,b),g=f.length;while(g--)d=K.call(a,f[g]),a[d]=!(c[d]=f[g])}):function(a){return e(a,0,c)}):e}},pseudos:{not:hb(function(a){var b=[],c=[],d=h(a.replace(R,"$1"));return d[u]?hb(function(a,b,c,e){var f,g=d(a,null,e,[]),h=a.length;while(h--)(f=g[h])&&(a[h]=!(b[h]=f))}):function(a,e,f){return b[0]=a,d(b,null,f,c),!c.pop()}}),has:hb(function(a){return function(b){return fb(a,b).length>0}}),contains:hb(function(a){return function(b){return(b.textContent||b.innerText||e(b)).indexOf(a)>-1}}),lang:hb(function(a){return W.test(a||"")||fb.error("unsupported lang: "+a),a=a.replace(cb,db).toLowerCase(),function(b){var c;do if(c=p?b.lang:b.getAttribute("xml:lang")||b.getAttribute("lang"))return c=c.toLowerCase(),c===a||0===c.indexOf(a+"-");while((b=b.parentNode)&&1===b.nodeType);return!1}}),target:function(b){var c=a.location&&a.location.hash;return c&&c.slice(1)===b.id},root:function(a){return a===o},focus:function(a){return a===n.activeElement&&(!n.hasFocus||n.hasFocus())&&!!(a.type||a.href||~a.tabIndex)},enabled:function(a){return a.disabled===!1},disabled:function(a){return a.disabled===!0},checked:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&!!a.checked||"option"===b&&!!a.selected},selected:function(a){return a.parentNode&&a.parentNode.selectedIndex,a.selected===!0},empty:function(a){for(a=a.firstChild;a;a=a.nextSibling)if(a.nodeType<6)return!1;return!0},parent:function(a){return!d.pseudos.empty(a)},header:function(a){return Z.test(a.nodeName)},input:function(a){return Y.test(a.nodeName)},button:function(a){var b=a.nodeName.toLowerCase();return"input"===b&&"button"===a.type||"button"===b},text:function(a){var b;return"input"===a.nodeName.toLowerCase()&&"text"===a.type&&(null==(b=a.getAttribute("type"))||"text"===b.toLowerCase())},first:nb(function(){return[0]}),last:nb(function(a,b){return[b-1]}),eq:nb(function(a,b,c){return[0>c?c+b:c]}),even:nb(function(a,b){for(var c=0;b>c;c+=2)a.push(c);return a}),odd:nb(function(a,b){for(var c=1;b>c;c+=2)a.push(c);return a}),lt:nb(function(a,b,c){for(var d=0>c?c+b:c;--d>=0;)a.push(d);return a}),gt:nb(function(a,b,c){for(var d=0>c?c+b:c;++db;b++)d+=a[b].value;return d}function rb(a,b,c){var d=b.dir,e=c&&"parentNode"===d,f=x++;return b.first?function(b,c,f){while(b=b[d])if(1===b.nodeType||e)return a(b,c,f)}:function(b,c,g){var h,i,j=[w,f];if(g){while(b=b[d])if((1===b.nodeType||e)&&a(b,c,g))return!0}else while(b=b[d])if(1===b.nodeType||e){if(i=b[u]||(b[u]={}),(h=i[d])&&h[0]===w&&h[1]===f)return j[2]=h[2];if(i[d]=j,j[2]=a(b,c,g))return!0}}}function sb(a){return a.length>1?function(b,c,d){var e=a.length;while(e--)if(!a[e](b,c,d))return!1;return!0}:a[0]}function tb(a,b,c){for(var d=0,e=b.length;e>d;d++)fb(a,b[d],c);return c}function ub(a,b,c,d,e){for(var f,g=[],h=0,i=a.length,j=null!=b;i>h;h++)(f=a[h])&&(!c||c(f,d,e))&&(g.push(f),j&&b.push(h));return g}function vb(a,b,c,d,e,f){return d&&!d[u]&&(d=vb(d)),e&&!e[u]&&(e=vb(e,f)),hb(function(f,g,h,i){var j,k,l,m=[],n=[],o=g.length,p=f||tb(b||"*",h.nodeType?[h]:h,[]),q=!a||!f&&b?p:ub(p,m,a,h,i),r=c?e||(f?a:o||d)?[]:g:q;if(c&&c(q,r,h,i),d){j=ub(r,n),d(j,[],h,i),k=j.length;while(k--)(l=j[k])&&(r[n[k]]=!(q[n[k]]=l))}if(f){if(e||a){if(e){j=[],k=r.length;while(k--)(l=r[k])&&j.push(q[k]=l);e(null,r=[],j,i)}k=r.length;while(k--)(l=r[k])&&(j=e?K.call(f,l):m[k])>-1&&(f[j]=!(g[j]=l))}}else r=ub(r===g?r.splice(o,r.length):r),e?e(null,g,r,i):I.apply(g,r)})}function wb(a){for(var b,c,e,f=a.length,g=d.relative[a[0].type],h=g||d.relative[" "],i=g?1:0,k=rb(function(a){return a===b},h,!0),l=rb(function(a){return K.call(b,a)>-1},h,!0),m=[function(a,c,d){return!g&&(d||c!==j)||((b=c).nodeType?k(a,c,d):l(a,c,d))}];f>i;i++)if(c=d.relative[a[i].type])m=[rb(sb(m),c)];else{if(c=d.filter[a[i].type].apply(null,a[i].matches),c[u]){for(e=++i;f>e;e++)if(d.relative[a[e].type])break;return vb(i>1&&sb(m),i>1&&qb(a.slice(0,i-1).concat({value:" "===a[i-2].type?"*":""})).replace(R,"$1"),c,e>i&&wb(a.slice(i,e)),f>e&&wb(a=a.slice(e)),f>e&&qb(a))}m.push(c)}return sb(m)}function xb(a,b){var c=b.length>0,e=a.length>0,f=function(f,g,h,i,k){var l,m,o,p=0,q="0",r=f&&[],s=[],t=j,u=f||e&&d.find.TAG("*",k),v=w+=null==t?1:Math.random()||.1,x=u.length;for(k&&(j=g!==n&&g);q!==x&&null!=(l=u[q]);q++){if(e&&l){m=0;while(o=a[m++])if(o(l,g,h)){i.push(l);break}k&&(w=v)}c&&((l=!o&&l)&&p--,f&&r.push(l))}if(p+=q,c&&q!==p){m=0;while(o=b[m++])o(r,s,g,h);if(f){if(p>0)while(q--)r[q]||s[q]||(s[q]=G.call(i));s=ub(s)}I.apply(i,s),k&&!f&&s.length>0&&p+b.length>1&&fb.uniqueSort(i)}return k&&(w=v,j=t),r};return c?hb(f):f}return h=fb.compile=function(a,b){var c,d=[],e=[],f=A[a+" "];if(!f){b||(b=g(a)),c=b.length;while(c--)f=wb(b[c]),f[u]?d.push(f):e.push(f);f=A(a,xb(e,d)),f.selector=a}return f},i=fb.select=function(a,b,e,f){var i,j,k,l,m,n="function"==typeof a&&a,o=!f&&g(a=n.selector||a);if(e=e||[],1===o.length){if(j=o[0]=o[0].slice(0),j.length>2&&"ID"===(k=j[0]).type&&c.getById&&9===b.nodeType&&p&&d.relative[j[1].type]){if(b=(d.find.ID(k.matches[0].replace(cb,db),b)||[])[0],!b)return e;n&&(b=b.parentNode),a=a.slice(j.shift().value.length)}i=X.needsContext.test(a)?0:j.length;while(i--){if(k=j[i],d.relative[l=k.type])break;if((m=d.find[l])&&(f=m(k.matches[0].replace(cb,db),ab.test(j[0].type)&&ob(b.parentNode)||b))){if(j.splice(i,1),a=f.length&&qb(j),!a)return I.apply(e,f),e;break}}}return(n||h(a,o))(f,b,!p,e,ab.test(a)&&ob(b.parentNode)||b),e},c.sortStable=u.split("").sort(B).join("")===u,c.detectDuplicates=!!l,m(),c.sortDetached=ib(function(a){return 1&a.compareDocumentPosition(n.createElement("div"))}),ib(function(a){return a.innerHTML="","#"===a.firstChild.getAttribute("href")})||jb("type|href|height|width",function(a,b,c){return c?void 0:a.getAttribute(b,"type"===b.toLowerCase()?1:2)}),c.attributes&&ib(function(a){return a.innerHTML="",a.firstChild.setAttribute("value",""),""===a.firstChild.getAttribute("value")})||jb("value",function(a,b,c){return c||"input"!==a.nodeName.toLowerCase()?void 0:a.defaultValue}),ib(function(a){return null==a.getAttribute("disabled")})||jb(L,function(a,b,c){var d;return c?void 0:a[b]===!0?b.toLowerCase():(d=a.getAttributeNode(b))&&d.specified?d.value:null}),fb}(a);m.find=s,m.expr=s.selectors,m.expr[":"]=m.expr.pseudos,m.unique=s.uniqueSort,m.text=s.getText,m.isXMLDoc=s.isXML,m.contains=s.contains;var t=m.expr.match.needsContext,u=/^<(\w+)\s*\/?>(?:<\/\1>|)$/,v=/^.[^:#\[\.,]*$/;function w(a,b,c){if(m.isFunction(b))return m.grep(a,function(a,d){return!!b.call(a,d,a)!==c});if(b.nodeType)return m.grep(a,function(a){return a===b!==c});if("string"==typeof b){if(v.test(b))return m.filter(b,a,c);b=m.filter(b,a)}return m.grep(a,function(a){return m.inArray(a,b)>=0!==c})}m.filter=function(a,b,c){var d=b[0];return c&&(a=":not("+a+")"),1===b.length&&1===d.nodeType?m.find.matchesSelector(d,a)?[d]:[]:m.find.matches(a,m.grep(b,function(a){return 1===a.nodeType}))},m.fn.extend({find:function(a){var b,c=[],d=this,e=d.length;if("string"!=typeof a)return this.pushStack(m(a).filter(function(){for(b=0;e>b;b++)if(m.contains(d[b],this))return!0}));for(b=0;e>b;b++)m.find(a,d[b],c);return c=this.pushStack(e>1?m.unique(c):c),c.selector=this.selector?this.selector+" "+a:a,c},filter:function(a){return this.pushStack(w(this,a||[],!1))},not:function(a){return this.pushStack(w(this,a||[],!0))},is:function(a){return!!w(this,"string"==typeof a&&t.test(a)?m(a):a||[],!1).length}});var x,y=a.document,z=/^(?:\s*(<[\w\W]+>)[^>]*|#([\w-]*))$/,A=m.fn.init=function(a,b){var c,d;if(!a)return this;if("string"==typeof a){if(c="<"===a.charAt(0)&&">"===a.charAt(a.length-1)&&a.length>=3?[null,a,null]:z.exec(a),!c||!c[1]&&b)return!b||b.jquery?(b||x).find(a):this.constructor(b).find(a);if(c[1]){if(b=b instanceof m?b[0]:b,m.merge(this,m.parseHTML(c[1],b&&b.nodeType?b.ownerDocument||b:y,!0)),u.test(c[1])&&m.isPlainObject(b))for(c in b)m.isFunction(this[c])?this[c](b[c]):this.attr(c,b[c]);return this}if(d=y.getElementById(c[2]),d&&d.parentNode){if(d.id!==c[2])return x.find(a);this.length=1,this[0]=d}return this.context=y,this.selector=a,this}return a.nodeType?(this.context=this[0]=a,this.length=1,this):m.isFunction(a)?"undefined"!=typeof x.ready?x.ready(a):a(m):(void 0!==a.selector&&(this.selector=a.selector,this.context=a.context),m.makeArray(a,this))};A.prototype=m.fn,x=m(y);var B=/^(?:parents|prev(?:Until|All))/,C={children:!0,contents:!0,next:!0,prev:!0};m.extend({dir:function(a,b,c){var d=[],e=a[b];while(e&&9!==e.nodeType&&(void 0===c||1!==e.nodeType||!m(e).is(c)))1===e.nodeType&&d.push(e),e=e[b];return d},sibling:function(a,b){for(var c=[];a;a=a.nextSibling)1===a.nodeType&&a!==b&&c.push(a);return c}}),m.fn.extend({has:function(a){var b,c=m(a,this),d=c.length;return this.filter(function(){for(b=0;d>b;b++)if(m.contains(this,c[b]))return!0})},closest:function(a,b){for(var c,d=0,e=this.length,f=[],g=t.test(a)||"string"!=typeof a?m(a,b||this.context):0;e>d;d++)for(c=this[d];c&&c!==b;c=c.parentNode)if(c.nodeType<11&&(g?g.index(c)>-1:1===c.nodeType&&m.find.matchesSelector(c,a))){f.push(c);break}return this.pushStack(f.length>1?m.unique(f):f)},index:function(a){return a?"string"==typeof a?m.inArray(this[0],m(a)):m.inArray(a.jquery?a[0]:a,this):this[0]&&this[0].parentNode?this.first().prevAll().length:-1},add:function(a,b){return this.pushStack(m.unique(m.merge(this.get(),m(a,b))))},addBack:function(a){return this.add(null==a?this.prevObject:this.prevObject.filter(a))}});function D(a,b){do a=a[b];while(a&&1!==a.nodeType);return a}m.each({parent:function(a){var b=a.parentNode;return b&&11!==b.nodeType?b:null},parents:function(a){return m.dir(a,"parentNode")},parentsUntil:function(a,b,c){return m.dir(a,"parentNode",c)},next:function(a){return D(a,"nextSibling")},prev:function(a){return D(a,"previousSibling")},nextAll:function(a){return m.dir(a,"nextSibling")},prevAll:function(a){return m.dir(a,"previousSibling")},nextUntil:function(a,b,c){return m.dir(a,"nextSibling",c)},prevUntil:function(a,b,c){return m.dir(a,"previousSibling",c)},siblings:function(a){return m.sibling((a.parentNode||{}).firstChild,a)},children:function(a){return m.sibling(a.firstChild)},contents:function(a){return m.nodeName(a,"iframe")?a.contentDocument||a.contentWindow.document:m.merge([],a.childNodes)}},function(a,b){m.fn[a]=function(c,d){var e=m.map(this,b,c);return"Until"!==a.slice(-5)&&(d=c),d&&"string"==typeof d&&(e=m.filter(d,e)),this.length>1&&(C[a]||(e=m.unique(e)),B.test(a)&&(e=e.reverse())),this.pushStack(e)}});var E=/\S+/g,F={};function G(a){var b=F[a]={};return m.each(a.match(E)||[],function(a,c){b[c]=!0}),b}m.Callbacks=function(a){a="string"==typeof a?F[a]||G(a):m.extend({},a);var b,c,d,e,f,g,h=[],i=!a.once&&[],j=function(l){for(c=a.memory&&l,d=!0,f=g||0,g=0,e=h.length,b=!0;h&&e>f;f++)if(h[f].apply(l[0],l[1])===!1&&a.stopOnFalse){c=!1;break}b=!1,h&&(i?i.length&&j(i.shift()):c?h=[]:k.disable())},k={add:function(){if(h){var d=h.length;!function f(b){m.each(b,function(b,c){var d=m.type(c);"function"===d?a.unique&&k.has(c)||h.push(c):c&&c.length&&"string"!==d&&f(c)})}(arguments),b?e=h.length:c&&(g=d,j(c))}return this},remove:function(){return h&&m.each(arguments,function(a,c){var d;while((d=m.inArray(c,h,d))>-1)h.splice(d,1),b&&(e>=d&&e--,f>=d&&f--)}),this},has:function(a){return a?m.inArray(a,h)>-1:!(!h||!h.length)},empty:function(){return h=[],e=0,this},disable:function(){return h=i=c=void 0,this},disabled:function(){return!h},lock:function(){return i=void 0,c||k.disable(),this},locked:function(){return!i},fireWith:function(a,c){return!h||d&&!i||(c=c||[],c=[a,c.slice?c.slice():c],b?i.push(c):j(c)),this},fire:function(){return k.fireWith(this,arguments),this},fired:function(){return!!d}};return k},m.extend({Deferred:function(a){var b=[["resolve","done",m.Callbacks("once memory"),"resolved"],["reject","fail",m.Callbacks("once memory"),"rejected"],["notify","progress",m.Callbacks("memory")]],c="pending",d={state:function(){return c},always:function(){return e.done(arguments).fail(arguments),this},then:function(){var a=arguments;return m.Deferred(function(c){m.each(b,function(b,f){var g=m.isFunction(a[b])&&a[b];e[f[1]](function(){var a=g&&g.apply(this,arguments);a&&m.isFunction(a.promise)?a.promise().done(c.resolve).fail(c.reject).progress(c.notify):c[f[0]+"With"](this===d?c.promise():this,g?[a]:arguments)})}),a=null}).promise()},promise:function(a){return null!=a?m.extend(a,d):d}},e={};return d.pipe=d.then,m.each(b,function(a,f){var g=f[2],h=f[3];d[f[1]]=g.add,h&&g.add(function(){c=h},b[1^a][2].disable,b[2][2].lock),e[f[0]]=function(){return e[f[0]+"With"](this===e?d:this,arguments),this},e[f[0]+"With"]=g.fireWith}),d.promise(e),a&&a.call(e,e),e},when:function(a){var b=0,c=d.call(arguments),e=c.length,f=1!==e||a&&m.isFunction(a.promise)?e:0,g=1===f?a:m.Deferred(),h=function(a,b,c){return function(e){b[a]=this,c[a]=arguments.length>1?d.call(arguments):e,c===i?g.notifyWith(b,c):--f||g.resolveWith(b,c)}},i,j,k;if(e>1)for(i=new Array(e),j=new Array(e),k=new Array(e);e>b;b++)c[b]&&m.isFunction(c[b].promise)?c[b].promise().done(h(b,k,c)).fail(g.reject).progress(h(b,j,i)):--f;return f||g.resolveWith(k,c),g.promise()}});var H;m.fn.ready=function(a){return m.ready.promise().done(a),this},m.extend({isReady:!1,readyWait:1,holdReady:function(a){a?m.readyWait++:m.ready(!0)},ready:function(a){if(a===!0?!--m.readyWait:!m.isReady){if(!y.body)return setTimeout(m.ready);m.isReady=!0,a!==!0&&--m.readyWait>0||(H.resolveWith(y,[m]),m.fn.triggerHandler&&(m(y).triggerHandler("ready"),m(y).off("ready")))}}});function I(){y.addEventListener?(y.removeEventListener("DOMContentLoaded",J,!1),a.removeEventListener("load",J,!1)):(y.detachEvent("onreadystatechange",J),a.detachEvent("onload",J))}function J(){(y.addEventListener||"load"===event.type||"complete"===y.readyState)&&(I(),m.ready())}m.ready.promise=function(b){if(!H)if(H=m.Deferred(),"complete"===y.readyState)setTimeout(m.ready);else if(y.addEventListener)y.addEventListener("DOMContentLoaded",J,!1),a.addEventListener("load",J,!1);else{y.attachEvent("onreadystatechange",J),a.attachEvent("onload",J);var c=!1;try{c=null==a.frameElement&&y.documentElement}catch(d){}c&&c.doScroll&&!function e(){if(!m.isReady){try{c.doScroll("left")}catch(a){return setTimeout(e,50)}I(),m.ready()}}()}return H.promise(b)};var K="undefined",L;for(L in m(k))break;k.ownLast="0"!==L,k.inlineBlockNeedsLayout=!1,m(function(){var a,b,c,d;c=y.getElementsByTagName("body")[0],c&&c.style&&(b=y.createElement("div"),d=y.createElement("div"),d.style.cssText="position:absolute;border:0;width:0;height:0;top:0;left:-9999px",c.appendChild(d).appendChild(b),typeof b.style.zoom!==K&&(b.style.cssText="display:inline;margin:0;border:0;padding:1px;width:1px;zoom:1",k.inlineBlockNeedsLayout=a=3===b.offsetWidth,a&&(c.style.zoom=1)),c.removeChild(d))}),function(){var a=y.createElement("div");if(null==k.deleteExpando){k.deleteExpando=!0;try{delete a.test}catch(b){k.deleteExpando=!1}}a=null}(),m.acceptData=function(a){var b=m.noData[(a.nodeName+" ").toLowerCase()],c=+a.nodeType||1;return 1!==c&&9!==c?!1:!b||b!==!0&&a.getAttribute("classid")===b};var M=/^(?:\{[\w\W]*\}|\[[\w\W]*\])$/,N=/([A-Z])/g;function O(a,b,c){if(void 0===c&&1===a.nodeType){var d="data-"+b.replace(N,"-$1").toLowerCase();if(c=a.getAttribute(d),"string"==typeof c){try{c="true"===c?!0:"false"===c?!1:"null"===c?null:+c+""===c?+c:M.test(c)?m.parseJSON(c):c}catch(e){}m.data(a,b,c)}else c=void 0}return c}function P(a){var b;for(b in a)if(("data"!==b||!m.isEmptyObject(a[b]))&&"toJSON"!==b)return!1;return!0}function Q(a,b,d,e){if(m.acceptData(a)){var f,g,h=m.expando,i=a.nodeType,j=i?m.cache:a,k=i?a[h]:a[h]&&h; -if(k&&j[k]&&(e||j[k].data)||void 0!==d||"string"!=typeof b)return k||(k=i?a[h]=c.pop()||m.guid++:h),j[k]||(j[k]=i?{}:{toJSON:m.noop}),("object"==typeof b||"function"==typeof b)&&(e?j[k]=m.extend(j[k],b):j[k].data=m.extend(j[k].data,b)),g=j[k],e||(g.data||(g.data={}),g=g.data),void 0!==d&&(g[m.camelCase(b)]=d),"string"==typeof b?(f=g[b],null==f&&(f=g[m.camelCase(b)])):f=g,f}}function R(a,b,c){if(m.acceptData(a)){var d,e,f=a.nodeType,g=f?m.cache:a,h=f?a[m.expando]:m.expando;if(g[h]){if(b&&(d=c?g[h]:g[h].data)){m.isArray(b)?b=b.concat(m.map(b,m.camelCase)):b in d?b=[b]:(b=m.camelCase(b),b=b in d?[b]:b.split(" ")),e=b.length;while(e--)delete d[b[e]];if(c?!P(d):!m.isEmptyObject(d))return}(c||(delete g[h].data,P(g[h])))&&(f?m.cleanData([a],!0):k.deleteExpando||g!=g.window?delete g[h]:g[h]=null)}}}m.extend({cache:{},noData:{"applet ":!0,"embed ":!0,"object ":"clsid:D27CDB6E-AE6D-11cf-96B8-444553540000"},hasData:function(a){return a=a.nodeType?m.cache[a[m.expando]]:a[m.expando],!!a&&!P(a)},data:function(a,b,c){return Q(a,b,c)},removeData:function(a,b){return R(a,b)},_data:function(a,b,c){return Q(a,b,c,!0)},_removeData:function(a,b){return R(a,b,!0)}}),m.fn.extend({data:function(a,b){var c,d,e,f=this[0],g=f&&f.attributes;if(void 0===a){if(this.length&&(e=m.data(f),1===f.nodeType&&!m._data(f,"parsedAttrs"))){c=g.length;while(c--)g[c]&&(d=g[c].name,0===d.indexOf("data-")&&(d=m.camelCase(d.slice(5)),O(f,d,e[d])));m._data(f,"parsedAttrs",!0)}return e}return"object"==typeof a?this.each(function(){m.data(this,a)}):arguments.length>1?this.each(function(){m.data(this,a,b)}):f?O(f,a,m.data(f,a)):void 0},removeData:function(a){return this.each(function(){m.removeData(this,a)})}}),m.extend({queue:function(a,b,c){var d;return a?(b=(b||"fx")+"queue",d=m._data(a,b),c&&(!d||m.isArray(c)?d=m._data(a,b,m.makeArray(c)):d.push(c)),d||[]):void 0},dequeue:function(a,b){b=b||"fx";var c=m.queue(a,b),d=c.length,e=c.shift(),f=m._queueHooks(a,b),g=function(){m.dequeue(a,b)};"inprogress"===e&&(e=c.shift(),d--),e&&("fx"===b&&c.unshift("inprogress"),delete f.stop,e.call(a,g,f)),!d&&f&&f.empty.fire()},_queueHooks:function(a,b){var c=b+"queueHooks";return m._data(a,c)||m._data(a,c,{empty:m.Callbacks("once memory").add(function(){m._removeData(a,b+"queue"),m._removeData(a,c)})})}}),m.fn.extend({queue:function(a,b){var c=2;return"string"!=typeof a&&(b=a,a="fx",c--),arguments.lengthh;h++)b(a[h],c,g?d:d.call(a[h],h,b(a[h],c)));return e?a:j?b.call(a):i?b(a[0],c):f},W=/^(?:checkbox|radio)$/i;!function(){var a=y.createElement("input"),b=y.createElement("div"),c=y.createDocumentFragment();if(b.innerHTML="
    a",k.leadingWhitespace=3===b.firstChild.nodeType,k.tbody=!b.getElementsByTagName("tbody").length,k.htmlSerialize=!!b.getElementsByTagName("link").length,k.html5Clone="<:nav>"!==y.createElement("nav").cloneNode(!0).outerHTML,a.type="checkbox",a.checked=!0,c.appendChild(a),k.appendChecked=a.checked,b.innerHTML="",k.noCloneChecked=!!b.cloneNode(!0).lastChild.defaultValue,c.appendChild(b),b.innerHTML="",k.checkClone=b.cloneNode(!0).cloneNode(!0).lastChild.checked,k.noCloneEvent=!0,b.attachEvent&&(b.attachEvent("onclick",function(){k.noCloneEvent=!1}),b.cloneNode(!0).click()),null==k.deleteExpando){k.deleteExpando=!0;try{delete b.test}catch(d){k.deleteExpando=!1}}}(),function(){var b,c,d=y.createElement("div");for(b in{submit:!0,change:!0,focusin:!0})c="on"+b,(k[b+"Bubbles"]=c in a)||(d.setAttribute(c,"t"),k[b+"Bubbles"]=d.attributes[c].expando===!1);d=null}();var X=/^(?:input|select|textarea)$/i,Y=/^key/,Z=/^(?:mouse|pointer|contextmenu)|click/,$=/^(?:focusinfocus|focusoutblur)$/,_=/^([^.]*)(?:\.(.+)|)$/;function ab(){return!0}function bb(){return!1}function cb(){try{return y.activeElement}catch(a){}}m.event={global:{},add:function(a,b,c,d,e){var f,g,h,i,j,k,l,n,o,p,q,r=m._data(a);if(r){c.handler&&(i=c,c=i.handler,e=i.selector),c.guid||(c.guid=m.guid++),(g=r.events)||(g=r.events={}),(k=r.handle)||(k=r.handle=function(a){return typeof m===K||a&&m.event.triggered===a.type?void 0:m.event.dispatch.apply(k.elem,arguments)},k.elem=a),b=(b||"").match(E)||[""],h=b.length;while(h--)f=_.exec(b[h])||[],o=q=f[1],p=(f[2]||"").split(".").sort(),o&&(j=m.event.special[o]||{},o=(e?j.delegateType:j.bindType)||o,j=m.event.special[o]||{},l=m.extend({type:o,origType:q,data:d,handler:c,guid:c.guid,selector:e,needsContext:e&&m.expr.match.needsContext.test(e),namespace:p.join(".")},i),(n=g[o])||(n=g[o]=[],n.delegateCount=0,j.setup&&j.setup.call(a,d,p,k)!==!1||(a.addEventListener?a.addEventListener(o,k,!1):a.attachEvent&&a.attachEvent("on"+o,k))),j.add&&(j.add.call(a,l),l.handler.guid||(l.handler.guid=c.guid)),e?n.splice(n.delegateCount++,0,l):n.push(l),m.event.global[o]=!0);a=null}},remove:function(a,b,c,d,e){var f,g,h,i,j,k,l,n,o,p,q,r=m.hasData(a)&&m._data(a);if(r&&(k=r.events)){b=(b||"").match(E)||[""],j=b.length;while(j--)if(h=_.exec(b[j])||[],o=q=h[1],p=(h[2]||"").split(".").sort(),o){l=m.event.special[o]||{},o=(d?l.delegateType:l.bindType)||o,n=k[o]||[],h=h[2]&&new RegExp("(^|\\.)"+p.join("\\.(?:.*\\.|)")+"(\\.|$)"),i=f=n.length;while(f--)g=n[f],!e&&q!==g.origType||c&&c.guid!==g.guid||h&&!h.test(g.namespace)||d&&d!==g.selector&&("**"!==d||!g.selector)||(n.splice(f,1),g.selector&&n.delegateCount--,l.remove&&l.remove.call(a,g));i&&!n.length&&(l.teardown&&l.teardown.call(a,p,r.handle)!==!1||m.removeEvent(a,o,r.handle),delete k[o])}else for(o in k)m.event.remove(a,o+b[j],c,d,!0);m.isEmptyObject(k)&&(delete r.handle,m._removeData(a,"events"))}},trigger:function(b,c,d,e){var f,g,h,i,k,l,n,o=[d||y],p=j.call(b,"type")?b.type:b,q=j.call(b,"namespace")?b.namespace.split("."):[];if(h=l=d=d||y,3!==d.nodeType&&8!==d.nodeType&&!$.test(p+m.event.triggered)&&(p.indexOf(".")>=0&&(q=p.split("."),p=q.shift(),q.sort()),g=p.indexOf(":")<0&&"on"+p,b=b[m.expando]?b:new m.Event(p,"object"==typeof b&&b),b.isTrigger=e?2:3,b.namespace=q.join("."),b.namespace_re=b.namespace?new RegExp("(^|\\.)"+q.join("\\.(?:.*\\.|)")+"(\\.|$)"):null,b.result=void 0,b.target||(b.target=d),c=null==c?[b]:m.makeArray(c,[b]),k=m.event.special[p]||{},e||!k.trigger||k.trigger.apply(d,c)!==!1)){if(!e&&!k.noBubble&&!m.isWindow(d)){for(i=k.delegateType||p,$.test(i+p)||(h=h.parentNode);h;h=h.parentNode)o.push(h),l=h;l===(d.ownerDocument||y)&&o.push(l.defaultView||l.parentWindow||a)}n=0;while((h=o[n++])&&!b.isPropagationStopped())b.type=n>1?i:k.bindType||p,f=(m._data(h,"events")||{})[b.type]&&m._data(h,"handle"),f&&f.apply(h,c),f=g&&h[g],f&&f.apply&&m.acceptData(h)&&(b.result=f.apply(h,c),b.result===!1&&b.preventDefault());if(b.type=p,!e&&!b.isDefaultPrevented()&&(!k._default||k._default.apply(o.pop(),c)===!1)&&m.acceptData(d)&&g&&d[p]&&!m.isWindow(d)){l=d[g],l&&(d[g]=null),m.event.triggered=p;try{d[p]()}catch(r){}m.event.triggered=void 0,l&&(d[g]=l)}return b.result}},dispatch:function(a){a=m.event.fix(a);var b,c,e,f,g,h=[],i=d.call(arguments),j=(m._data(this,"events")||{})[a.type]||[],k=m.event.special[a.type]||{};if(i[0]=a,a.delegateTarget=this,!k.preDispatch||k.preDispatch.call(this,a)!==!1){h=m.event.handlers.call(this,a,j),b=0;while((f=h[b++])&&!a.isPropagationStopped()){a.currentTarget=f.elem,g=0;while((e=f.handlers[g++])&&!a.isImmediatePropagationStopped())(!a.namespace_re||a.namespace_re.test(e.namespace))&&(a.handleObj=e,a.data=e.data,c=((m.event.special[e.origType]||{}).handle||e.handler).apply(f.elem,i),void 0!==c&&(a.result=c)===!1&&(a.preventDefault(),a.stopPropagation()))}return k.postDispatch&&k.postDispatch.call(this,a),a.result}},handlers:function(a,b){var c,d,e,f,g=[],h=b.delegateCount,i=a.target;if(h&&i.nodeType&&(!a.button||"click"!==a.type))for(;i!=this;i=i.parentNode||this)if(1===i.nodeType&&(i.disabled!==!0||"click"!==a.type)){for(e=[],f=0;h>f;f++)d=b[f],c=d.selector+" ",void 0===e[c]&&(e[c]=d.needsContext?m(c,this).index(i)>=0:m.find(c,this,null,[i]).length),e[c]&&e.push(d);e.length&&g.push({elem:i,handlers:e})}return h]","i"),hb=/^\s+/,ib=/<(?!area|br|col|embed|hr|img|input|link|meta|param)(([\w:]+)[^>]*)\/>/gi,jb=/<([\w:]+)/,kb=/\s*$/g,rb={option:[1,""],legend:[1,"
    ","
    "],area:[1,"",""],param:[1,"",""],thead:[1,"","
    "],tr:[2,"","
    "],col:[2,"","
    "],td:[3,"","
    "],_default:k.htmlSerialize?[0,"",""]:[1,"X
    ","
    "]},sb=db(y),tb=sb.appendChild(y.createElement("div"));rb.optgroup=rb.option,rb.tbody=rb.tfoot=rb.colgroup=rb.caption=rb.thead,rb.th=rb.td;function ub(a,b){var c,d,e=0,f=typeof a.getElementsByTagName!==K?a.getElementsByTagName(b||"*"):typeof a.querySelectorAll!==K?a.querySelectorAll(b||"*"):void 0;if(!f)for(f=[],c=a.childNodes||a;null!=(d=c[e]);e++)!b||m.nodeName(d,b)?f.push(d):m.merge(f,ub(d,b));return void 0===b||b&&m.nodeName(a,b)?m.merge([a],f):f}function vb(a){W.test(a.type)&&(a.defaultChecked=a.checked)}function wb(a,b){return m.nodeName(a,"table")&&m.nodeName(11!==b.nodeType?b:b.firstChild,"tr")?a.getElementsByTagName("tbody")[0]||a.appendChild(a.ownerDocument.createElement("tbody")):a}function xb(a){return a.type=(null!==m.find.attr(a,"type"))+"/"+a.type,a}function yb(a){var b=pb.exec(a.type);return b?a.type=b[1]:a.removeAttribute("type"),a}function zb(a,b){for(var c,d=0;null!=(c=a[d]);d++)m._data(c,"globalEval",!b||m._data(b[d],"globalEval"))}function Ab(a,b){if(1===b.nodeType&&m.hasData(a)){var c,d,e,f=m._data(a),g=m._data(b,f),h=f.events;if(h){delete g.handle,g.events={};for(c in h)for(d=0,e=h[c].length;e>d;d++)m.event.add(b,c,h[c][d])}g.data&&(g.data=m.extend({},g.data))}}function Bb(a,b){var c,d,e;if(1===b.nodeType){if(c=b.nodeName.toLowerCase(),!k.noCloneEvent&&b[m.expando]){e=m._data(b);for(d in e.events)m.removeEvent(b,d,e.handle);b.removeAttribute(m.expando)}"script"===c&&b.text!==a.text?(xb(b).text=a.text,yb(b)):"object"===c?(b.parentNode&&(b.outerHTML=a.outerHTML),k.html5Clone&&a.innerHTML&&!m.trim(b.innerHTML)&&(b.innerHTML=a.innerHTML)):"input"===c&&W.test(a.type)?(b.defaultChecked=b.checked=a.checked,b.value!==a.value&&(b.value=a.value)):"option"===c?b.defaultSelected=b.selected=a.defaultSelected:("input"===c||"textarea"===c)&&(b.defaultValue=a.defaultValue)}}m.extend({clone:function(a,b,c){var d,e,f,g,h,i=m.contains(a.ownerDocument,a);if(k.html5Clone||m.isXMLDoc(a)||!gb.test("<"+a.nodeName+">")?f=a.cloneNode(!0):(tb.innerHTML=a.outerHTML,tb.removeChild(f=tb.firstChild)),!(k.noCloneEvent&&k.noCloneChecked||1!==a.nodeType&&11!==a.nodeType||m.isXMLDoc(a)))for(d=ub(f),h=ub(a),g=0;null!=(e=h[g]);++g)d[g]&&Bb(e,d[g]);if(b)if(c)for(h=h||ub(a),d=d||ub(f),g=0;null!=(e=h[g]);g++)Ab(e,d[g]);else Ab(a,f);return d=ub(f,"script"),d.length>0&&zb(d,!i&&ub(a,"script")),d=h=e=null,f},buildFragment:function(a,b,c,d){for(var e,f,g,h,i,j,l,n=a.length,o=db(b),p=[],q=0;n>q;q++)if(f=a[q],f||0===f)if("object"===m.type(f))m.merge(p,f.nodeType?[f]:f);else if(lb.test(f)){h=h||o.appendChild(b.createElement("div")),i=(jb.exec(f)||["",""])[1].toLowerCase(),l=rb[i]||rb._default,h.innerHTML=l[1]+f.replace(ib,"<$1>")+l[2],e=l[0];while(e--)h=h.lastChild;if(!k.leadingWhitespace&&hb.test(f)&&p.push(b.createTextNode(hb.exec(f)[0])),!k.tbody){f="table"!==i||kb.test(f)?""!==l[1]||kb.test(f)?0:h:h.firstChild,e=f&&f.childNodes.length;while(e--)m.nodeName(j=f.childNodes[e],"tbody")&&!j.childNodes.length&&f.removeChild(j)}m.merge(p,h.childNodes),h.textContent="";while(h.firstChild)h.removeChild(h.firstChild);h=o.lastChild}else p.push(b.createTextNode(f));h&&o.removeChild(h),k.appendChecked||m.grep(ub(p,"input"),vb),q=0;while(f=p[q++])if((!d||-1===m.inArray(f,d))&&(g=m.contains(f.ownerDocument,f),h=ub(o.appendChild(f),"script"),g&&zb(h),c)){e=0;while(f=h[e++])ob.test(f.type||"")&&c.push(f)}return h=null,o},cleanData:function(a,b){for(var d,e,f,g,h=0,i=m.expando,j=m.cache,l=k.deleteExpando,n=m.event.special;null!=(d=a[h]);h++)if((b||m.acceptData(d))&&(f=d[i],g=f&&j[f])){if(g.events)for(e in g.events)n[e]?m.event.remove(d,e):m.removeEvent(d,e,g.handle);j[f]&&(delete j[f],l?delete d[i]:typeof d.removeAttribute!==K?d.removeAttribute(i):d[i]=null,c.push(f))}}}),m.fn.extend({text:function(a){return V(this,function(a){return void 0===a?m.text(this):this.empty().append((this[0]&&this[0].ownerDocument||y).createTextNode(a))},null,a,arguments.length)},append:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=wb(this,a);b.appendChild(a)}})},prepend:function(){return this.domManip(arguments,function(a){if(1===this.nodeType||11===this.nodeType||9===this.nodeType){var b=wb(this,a);b.insertBefore(a,b.firstChild)}})},before:function(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this)})},after:function(){return this.domManip(arguments,function(a){this.parentNode&&this.parentNode.insertBefore(a,this.nextSibling)})},remove:function(a,b){for(var c,d=a?m.filter(a,this):this,e=0;null!=(c=d[e]);e++)b||1!==c.nodeType||m.cleanData(ub(c)),c.parentNode&&(b&&m.contains(c.ownerDocument,c)&&zb(ub(c,"script")),c.parentNode.removeChild(c));return this},empty:function(){for(var a,b=0;null!=(a=this[b]);b++){1===a.nodeType&&m.cleanData(ub(a,!1));while(a.firstChild)a.removeChild(a.firstChild);a.options&&m.nodeName(a,"select")&&(a.options.length=0)}return this},clone:function(a,b){return a=null==a?!1:a,b=null==b?a:b,this.map(function(){return m.clone(this,a,b)})},html:function(a){return V(this,function(a){var b=this[0]||{},c=0,d=this.length;if(void 0===a)return 1===b.nodeType?b.innerHTML.replace(fb,""):void 0;if(!("string"!=typeof a||mb.test(a)||!k.htmlSerialize&&gb.test(a)||!k.leadingWhitespace&&hb.test(a)||rb[(jb.exec(a)||["",""])[1].toLowerCase()])){a=a.replace(ib,"<$1>");try{for(;d>c;c++)b=this[c]||{},1===b.nodeType&&(m.cleanData(ub(b,!1)),b.innerHTML=a);b=0}catch(e){}}b&&this.empty().append(a)},null,a,arguments.length)},replaceWith:function(){var a=arguments[0];return this.domManip(arguments,function(b){a=this.parentNode,m.cleanData(ub(this)),a&&a.replaceChild(b,this)}),a&&(a.length||a.nodeType)?this:this.remove()},detach:function(a){return this.remove(a,!0)},domManip:function(a,b){a=e.apply([],a);var c,d,f,g,h,i,j=0,l=this.length,n=this,o=l-1,p=a[0],q=m.isFunction(p);if(q||l>1&&"string"==typeof p&&!k.checkClone&&nb.test(p))return this.each(function(c){var d=n.eq(c);q&&(a[0]=p.call(this,c,d.html())),d.domManip(a,b)});if(l&&(i=m.buildFragment(a,this[0].ownerDocument,!1,this),c=i.firstChild,1===i.childNodes.length&&(i=c),c)){for(g=m.map(ub(i,"script"),xb),f=g.length;l>j;j++)d=i,j!==o&&(d=m.clone(d,!0,!0),f&&m.merge(g,ub(d,"script"))),b.call(this[j],d,j);if(f)for(h=g[g.length-1].ownerDocument,m.map(g,yb),j=0;f>j;j++)d=g[j],ob.test(d.type||"")&&!m._data(d,"globalEval")&&m.contains(h,d)&&(d.src?m._evalUrl&&m._evalUrl(d.src):m.globalEval((d.text||d.textContent||d.innerHTML||"").replace(qb,"")));i=c=null}return this}}),m.each({appendTo:"append",prependTo:"prepend",insertBefore:"before",insertAfter:"after",replaceAll:"replaceWith"},function(a,b){m.fn[a]=function(a){for(var c,d=0,e=[],g=m(a),h=g.length-1;h>=d;d++)c=d===h?this:this.clone(!0),m(g[d])[b](c),f.apply(e,c.get());return this.pushStack(e)}});var Cb,Db={};function Eb(b,c){var d,e=m(c.createElement(b)).appendTo(c.body),f=a.getDefaultComputedStyle&&(d=a.getDefaultComputedStyle(e[0]))?d.display:m.css(e[0],"display");return e.detach(),f}function Fb(a){var b=y,c=Db[a];return c||(c=Eb(a,b),"none"!==c&&c||(Cb=(Cb||m("