Resource

public struct Resource<Model>

Resource describes a remote resource of generic type. The type can be fetched via HTTP(S) and parsed into the coresponding model object.

Example:

let request: URLRequest = //
let resource: Resource<String?> = Resource(request: request, parse: { data in
   String(data: data, encoding: .utf8)
})


                    
                    
                    parse

Parses data into given model.

Swift

public let parse: (_ data: Data) throws -> Model


                    
                    
                    init(request:parse:)

Creates a type safe resource, which can be used to fetch it with NetworkService

Swift

public init(request: URLRequest, parse: @escaping (Data) throws -> Model)

`request`	The request to get the remote data payload
`parse`	Parses data fetched with the request into given Model


                    
                    
                    init(request:decoder:)

Creates an instace of Resource where the result type is Decodable and can be decoded with the given decoder

Swift

public init(request: URLRequest, decoder: JSONDecoder)

`request`	The request to get the remote data payload
`decoder`	a decoder which can decode the payload into the model type


                    
                    
                    inspectData(_:)

This lets one inspect the data payload before data gets parsed.

let resource: Resource<Train> = //
resource.inspectData { data in
   print(String(bytes: data, encoding: .utf8))
}

Swift

public func inspectData(_ inspector: @escaping (Data) -> Void) -> Resource<Model>


                                inspector

closure which gets passed the data

a new resource which gets instepcted before parsing


                    
                    
                    map(transform:)

Maps a resource result to a different resource. This is useful when you have result of R which contains T and your API request a resource of T,

Swift

public func map<T>(transform: @escaping (Model) throws -> T) -> Resource<T>


                                transform

transforms the original result of the resource

the transformed resource