Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Require explicit typing for DocumentSnapshot decoding. DocumentReference decoding. #9101

Merged
merged 12 commits into from
Feb 23, 2022
Merged

Require explicit typing for DocumentSnapshot decoding. DocumentReference decoding. #9101

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
0e4769c
Require explicit typing for DocumentSnapshot decoding. Add DocumentRe…
mortenbekditlevsen Dec 14, 2021
7815580
Updated doc comments. Added async version of getDocument(as:)
mortenbekditlevsen Dec 15, 2021
4ff41d7
Ran style.sh
mortenbekditlevsen Dec 15, 2021
37fb5be
Added LLC to copyright notice
mortenbekditlevsen Jan 3, 2022
6a94a62
Fixed up comments
mortenbekditlevsen Jan 18, 2022
31e3341
Merge branch 'master' into firestore_documentreference_codable
mortenbekditlevsen Jan 23, 2022
2eb244f
Ran style.sh
mortenbekditlevsen Jan 23, 2022
1d2f5d4
Change defaulting mechanism
mortenbekditlevsen Jan 27, 2022
c3e8cb3
Changes after review from Peter Friese
mortenbekditlevsen Feb 17, 2022
848f5e2
Updated CodableIntegrationTests to match updated API
mortenbekditlevsen Feb 18, 2022
f6a3733
Added offline behavior description from Objective-C documentation and…
mortenbekditlevsen Feb 22, 2022
9ce7b61
Updated comment after review
mortenbekditlevsen Feb 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Prev Previous commit
Next Next commit
Ran style.sh
  • Loading branch information
@mortenbekditlevsen
mortenbekditlevsen committed Dec 15, 2021
commit 4ff41d7b4e543f6ef740725e1d6b9f92a18fb9ff
48 changes: 24 additions & 24 deletions Firestore/Swift/Source/Codable/DocumentReference+ReadDecodable.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,30 +56,30 @@ extension DocumentReference {
}
}

// TODO: How do you annotate that using Xcode 13.2 you can actually compile to earlier os versions
#if compiler(>=5.5) && canImport(_Concurrency)
/// Fetches and decodes the document referenced by this `DocumentReference`.
///
/// This allows users to retrieve a Firestore document and have it decoded to an instance of
/// caller-specified type.
/// ```swift
/// let book = try await ref.getDocument(as: Book.self)
/// ```
/// - Parameters:
/// - as: A `Decodable` type to convert the document fields to.
/// - serverTimestampBehavior: Configures how server timestamps that have
/// not yet been set to their final value are returned from the snapshot.
/// - decoder: The decoder to use to convert the document. `nil` to use
/// - Returns: This instance of the supplied `Decodable` type `T`.
@available(iOS 15, tvOS 15, macOS 12, watchOS 8, *)
public func getDocument<T: Decodable>(as type: T.Type,
with serverTimestampBehavior: ServerTimestampBehavior =
.none,
decoder: Firestore.Decoder? = nil) async throws -> T {
// TODO: How do you annotate that using Xcode 13.2 you can actually compile to earlier os versions
mortenbekditlevsen marked this conversation as resolved.
Show resolved Hide resolved
#if compiler(>=5.5) && canImport(_Concurrency)
/// Fetches and decodes the document referenced by this `DocumentReference`.
///
/// This allows users to retrieve a Firestore document and have it decoded to an instance of
/// caller-specified type.
/// ```swift
/// let book = try await ref.getDocument(as: Book.self)
mortenbekditlevsen marked this conversation as resolved.
Show resolved Hide resolved
/// ```
/// - Parameters:
/// - as: A `Decodable` type to convert the document fields to.
/// - serverTimestampBehavior: Configures how server timestamps that have
/// not yet been set to their final value are returned from the snapshot.
/// - decoder: The decoder to use to convert the document. `nil` to use
mortenbekditlevsen marked this conversation as resolved.
Show resolved Hide resolved
/// - Returns: This instance of the supplied `Decodable` type `T`.
@available(iOS 15, tvOS 15, macOS 12, watchOS 8, *)
public func getDocument<T: Decodable>(as type: T.Type,
with serverTimestampBehavior: ServerTimestampBehavior =
.none,
decoder: Firestore.Decoder? = nil) async throws -> T {
let snapshot = try await getDocument()
return try snapshot.data(as: T.self,
with: serverTimestampBehavior,
decoder: decoder)
}
#endif
with: serverTimestampBehavior,
decoder: decoder)
}
#endif
}
2 changes: 1 addition & 1 deletion Firestore/Swift/Source/Codable/DocumentSnapshot+ReadDecodable.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import FirebaseFirestore

extension DocumentSnapshot {
/// Retrieves all fields in a document and converts them to an instance of
/// caller-specified type.
/// caller-specified type.
///
/// By default, server-provided timestamps that have not yet been set to their
/// final value will be returned as `NSNull`. Pass `serverTimestampBehavior`
mortenbekditlevsen marked this conversation as resolved.
Show resolved Hide resolved
Expand Down