magnetardev / SwiftFetch

A Swift implementation of JavaScript's fetch function.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

SwiftFetch

Similar to the JavaScript fetch() Promise, SwiftFetch is a simple and easy to use way to fetch web content in Swift. Since SwiftFetch expands off of Bluebird, it is recommended that you understand how to use that.

Dependencies

Documentation

Import

import SwiftFetch

Fetch

Fetch returns a promise, similar to JavaScript. The resolved value from the fetch is a FetchResponse item. This will let you run things like .text() and .json() easily, more info on this class can be found below.

fetch(url: URL(string: "https://google.com")!).then { res in
    let textResponse = res.text();
    print(textResponse);
}.catch { err in
    print(err);
}

FetchOptions Optional values to pass to the fetch function.

public struct FetchOptions {
    public var headers: [String:String]? = nil
    public var body: Data? = nil
    public var method: FetchMethod? = .GET
}
  • headers is a Dictionary with all your headers.
  • body is the body you want to pass via a POST request, or likewise.
  • method is one of the available methods. A list can be found below.

FetchResponse

If successful, a fetch will return a FetchResponse in it's Promise. This helps streamline the process, and make it more similar to the JavaScript version.

public class FetchResponse {
    public let data: Data;
    public let response: URLResponse;
    public func text() -> String;
    public func json<T: Decodable>(handler: T.Type) -> Any;
}
  • data is the returned Data from the fetch call.
  • response is the returned Response from the fetch call.
  • text() is a simple function that converts the data into text.
  • json() simplifies the json parsing process. It takes in a Decodable struct.

FetchMethod

The supported methods for SwiftFetch.

public enum FetchMethod: String {
    case GET = "GET"
    case HEAD = "HEAD"
    case POST = "POST"
    case PUT = "PUT"
    case DELETE = "DELETE"
    case CONNECT = "CONNECT"
    case OPTIONS = "OPTIONS"
    case TRACE = "TRACE"
    case PATCH = "PATCH"
}

Examples

Text

fetch(url: URL(string: "https://google.com")!).then { res in
    let textResponse = res.text();
    print(textResponse);
}.catch { err in
    print(err);
}

JSON

struct Project: Decodable {
    let id: String
    let name: String
    let desc: String
    let version: String
    let icon: String
    let link: String
    let banner: String
}
fetch(url: URL(string: "https://api.magnetardev.pro/magnetar/get/projects")!).then { res in
    let projectsList = res.json(handler: [Project].self) as! [Project];
    print(projectsList);
}.catch { error in
    print(error);
};

About

A Swift implementation of JavaScript's fetch function.

License:GNU General Public License v3.0


Languages

Language:Swift 100.0%