feat: add docs for CLLocation authorization

gtokman · May 6, 2021 · 6672ed8 · 6672ed8
1 parent 7e2df3a
commit 6672ed8
Showing 1 changed file with 35 additions and 0 deletions.
diff --git a/Sources/ExtensionKit/CoreLocation/CLLocationManager.swift b/Sources/ExtensionKit/CoreLocation/CLLocationManager.swift
@@ -3,6 +3,41 @@ import CoreLocation
 
 public extension CLLocationManager {
 
+    /*
+     ```
+     class LocationStore: ObservableObject {
+         
+         @Published var coordinate: CLLocationCoordinate2D = .zero
+         @Published var status: CLAuthorizationStatus = .notDetermined
+         
+         let manager = CLLocationManager()
+         
+         var cancellables = Set<AnyCancellable>()
+         
+         func requestPermission() {
+             CLLocationManager
+                 .requestLocationAuthorization(with: manager, type: .whenInUse)
+                 .assign(to: \.status, on: self)
+                 .store(in: &cancellables)
+         }
+         
+         func getLocation() {
+             CLLocationManager
+                 .receiveLocationUpdates(from: manager)
+                 .compactMap(\.last)
+                 .map(\.coordinate)
+                 .sink { result in
+                     if case let .failure(error) = result {
+                         dprint("Error: \(error.localizedDescription)")
+                     }
+                 } receiveValue: { coordinate in
+                     self.coordinate = coordinate
+                 }
+                 .store(in: &cancellables)
+         }
+     }
+     ```
+     **/
     /// Request locaton authorization and subscribe to `CLAuthorizationStatus` updates
     /// - Parameters:
     ///   - manager: `CLLocationManager`