René's URL Explorer Experiment


Title: docs(firestore): type reads with a converter instead of a type argument by armando-navarro · Pull Request #3838 · angular/angularfire · GitHub

Open Graph Title: docs(firestore): type reads with a converter instead of a type argument by armando-navarro · Pull Request #3838 · angular/angularfire

X Title: docs(firestore): type reads with a converter instead of a type argument by armando-navarro · Pull Request #3838 · angular/angularfire

Description: Checklist Issue number for this PR: #3081 (and its duplicate #3073) Docs included?: yes, this is a docs-only change. Test units included?: no, Markdown only. Breaking change?: no. In a clean directory, yarn install, yarn test run successfully? Not run, the change is four Markdown files. npm run lint passed on the commit. Description The README, the quickstart (docs/install-and-setup.md) and the v7 upgrade guide show collectionData(collection(firestore, 'items')), which doesn't compile. collection() returns a reference typed DocumentData, and collectionData asks for Query, so TypeScript reports TS2345. docs/firestore.md casts instead, collectionData(ref) as Observable, which compiles but checks nothing about the stored documents. #3081 and #3073 are readers asking for a typed collection(), and the thread workarounds are the cast and a helper service. The signature comes from the Firebase SDK, where the type lives on the reference through withConverter() (see #2931). The docs now teach that. Changes README.md and docs/install-and-setup.md: the Item example attaches a FirestoreDataConverter whose fromFirestore substitutes '' for a missing or non-string name, reads through collection(...).withConverter(itemConverter), and calls collectionData() with no type argument. One sentence under the example links to the new section. docs/firestore.md: the UserProfile example gets the same converter, the cast goes, and a new "Typed reads" subsection explains why the two shortcuts do not give a typed read, where the default-versus-throw choice lives (fromFirestore runs on every document, so a throw there errors the observable at the first bad document), and that idField performs no validation. docs/version-7-upgrade.md: a sentence above the v6-to-v7 table defines docRef as a converter-typed reference, the collection(docRef, 'bar') // CollectionReference row is corrected (both collection(reference, path) overloads return CollectionReference), docData's return type gains | undefined, and the code-splitting snippet uses a converter and imports concatMap. Checked on a fresh Angular 22.2.4 app with @angular/fire 22.0.0-rc.0: the quickstart text builds as written, the previous collectionData(aCollection) line fails the same build with TS2345, and against the Firestore emulator the documented converter keeps emitting on malformed documents while a throwing one ends the subscription. Not changed: site/src/get-started/quick-start.md still shows the cast. site/ is the unbuilt duplicate docs tree whose fate is a separate decision. Fixes #3081 Fixes #3073

Open Graph Description: Checklist Issue number for this PR: #3081 (and its duplicate #3073) Docs included?: yes, this is a docs-only change. Test units included?: no, Markdown only. Breaking change?: no. In a clean direc...

X Description: Checklist Issue number for this PR: #3081 (and its duplicate #3073) Docs included?: yes, this is a docs-only change. Test units included?: no, Markdown only. Breaking change?: no. In a clean direc...

Opengraph URL: https://github.com/angular/angularfire/pull/3838

X: @github

direct link

Domain: github.com

IPv4 address: 140.82.114.3

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322
route-pattern/:user_id/:repository/pull/:id/files(.:format)
route-controllerpull_requests
route-actionfiles
fetch-noncev2:99a941c3-133a-e763-a0a1-5f6bbb2fb619
current-catalog-service-hashae870bc5e265a340912cde392f23dad3671a0a881730ffdadd82f2f57d81641b
request-id90EC:161BA9:9A09A0:C2865C:6B036335
html-safe-nonce7aa2ad3cfa8a937d70fea9aa497bd54c276b2357823417f301a3fb437c3d614a
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5MEVDOjE2MUJBOTo5QTA5QTA6QzI4NjVDOjZCMDM2MzM1IiwidmlzaXRvcl9pZCI6IjUzMTkyMzc2Mzk3ODA2NTU5MjUiLCJyZWdpb25fZWRnZSI6ImlhZCIsInJlZ2lvbl9yZW5kZXIiOiJpYWQifQ==
visitor-hmac2abad28ec6a48177f1c9cd162a3cf50f4b25b0cea0d030943102688d3cace2f9
hovercard-subject-tagpull_request:5175980007
github-keyboard-shortcutsrepository,pull-request-list,pull-request-conversation,pull-request-files-changed,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///pull_requests/show/files
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/angular/angularfire/pull/3838/files
twitter:imagehttps://avatars.githubusercontent.com/u/13904589?s=400&v=4
twitter:cardsummary_large_image
og:imagehttps://avatars.githubusercontent.com/u/13904589?s=400&v=4
og:image:altChecklist Issue number for this PR: #3081 (and its duplicate #3073) Docs included?: yes, this is a docs-only change. Test units included?: no, Markdown only. Breaking change?: no. In a clean direc...
og:site_nameGitHub
og:typeobject
hostnamegithub.com
expected-hostnamegithub.com
None87e774ee7c6b3bee0490394e4d3e57ec9dbc956f74b87ea685dc8996c1676456
turbo-cache-controlno-preview
diff-viewunified
go-importgithub.com/angular/angularfire git https://github.com/angular/angularfire.git
octolytics-dimension-user_id139426
octolytics-dimension-user_loginangular
octolytics-dimension-repository_id49453413
octolytics-dimension-repository_nwoangular/angularfire
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id49453413
octolytics-dimension-repository_network_root_nwoangular/angularfire
turbo-body-classeslogged-out env-production page-responsive full-width
disable-turbotrue
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release423dbb54c5e7bfecc838eb387c1435eb3d0e760d
ui-targetfull
theme-color#1e2327
color-schemelight dark

Links:

Skip to contenthttps://github.com/angular/angularfire/pull/3838/files#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fangular%2Fangularfire%2Fpull%2F3838%2Ffiles
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fangular%2Fangularfire%2Fpull%2F3838%2Ffiles
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fpull_requests%2Fshow%2Ffiles&source=header-repo&source_repo=angular%2Fangularfire
Reloadhttps://github.com/angular/angularfire/pull/3838/files
Reloadhttps://github.com/angular/angularfire/pull/3838/files
Reloadhttps://github.com/angular/angularfire/pull/3838/files
angularhttps://github.com/angular
angularfirehttps://github.com/angular/angularfire
Codehttps://github.com/angular/angularfire
Issues162 (162)https://github.com/angular/angularfire/issues
Pull requests5 (5)https://github.com/angular/angularfire/pulls
Discussionshttps://github.com/angular/angularfire/discussions
Actionshttps://github.com/angular/angularfire/actions
Projectshttps://github.com/angular/angularfire/projects
Security and qualityhttps://github.com/angular/angularfire/security
Insightshttps://github.com/angular/angularfire/insights
Sign up for GitHub https://github.com/signup?return_to=%2Fangular%2Fangularfire%2Fissues%2Fnew%2Fchoose
terms of servicehttps://docs.github.com/terms
privacy statementhttps://docs.github.com/privacy
Sign inhttps://github.com/login?return_to=%2Fangular%2Fangularfire%2Fissues%2Fnew%2Fchoose
armando-navarrohttps://github.com/armando-navarro
angular:mainhttps://github.com/angular/angularfire/tree/main
armando-navarro:docs-typed-firestore-readshttps://github.com/armando-navarro/angularfire/tree/docs-typed-firestore-reads
Conversation 0 https://github.com/angular/angularfire/pull/3838
Commits 2 https://github.com/angular/angularfire/pull/3838/commits
Checks 25 https://github.com/angular/angularfire/pull/3838/checks
Files changed https://github.com/angular/angularfire/pull/3838/files
Please reload this pagehttps://github.com/angular/angularfire/pull/3838/files
docs(firestore): type reads with a converter instead of a type argument https://github.com/angular/angularfire/pull/3838/files#top
Show all changes 2 commits https://github.com/angular/angularfire/pull/3838/files
ef508b5 docs(firestore): type reads with a converter instead of a type argument armando-navarro Nov 5, 2026 https://github.com/angular/angularfire/pull/3838/commits/ef508b5236dbf301382b82d8ba5a4fe298dbaa8e
63283de Merge branch 'main' into docs-typed-firestore-reads armando-navarro Nov 6, 2026 https://github.com/angular/angularfire/pull/3838/commits/63283defba2629d16fb6b259781cb61daedc1446
Clear filters https://github.com/angular/angularfire/pull/3838/files
Please reload this pagehttps://github.com/angular/angularfire/pull/3838/files
Please reload this pagehttps://github.com/angular/angularfire/pull/3838/files
README.md https://github.com/angular/angularfire/pull/3838/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5
firestore.md https://github.com/angular/angularfire/pull/3838/files#diff-f1599226b85de4dcdf3a09df5814a2829bf7f635f4c92542915755a5d00b42db
install-and-setup.md https://github.com/angular/angularfire/pull/3838/files#diff-70728a44f408aaf005cff7035bf28d1480695b5bbab39b10ff8e34a7ec688464
version-7-upgrade.md https://github.com/angular/angularfire/pull/3838/files#diff-850dbe65f991a788a906a5d910395205d2304f8b02402e9f566f30864c8cec0f
README.mdhttps://github.com/angular/angularfire/pull/3838/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5
View file https://github.com/armando-navarro/angularfire/blob/63283defba2629d16fb6b259781cb61daedc1446/README.md
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/angular/angularfire/pull/3838/{{ revealButtonHref }}
https://github.com/angular/angularfire/pull/3838/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5
https://github.com/angular/angularfire/pull/3838/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5
https://github.com/angular/angularfire/pull/3838/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5
docs/firestore.mdhttps://github.com/angular/angularfire/pull/3838/files#diff-f1599226b85de4dcdf3a09df5814a2829bf7f635f4c92542915755a5d00b42db
View file https://github.com/armando-navarro/angularfire/blob/63283defba2629d16fb6b259781cb61daedc1446/docs/firestore.md
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/angular/angularfire/pull/3838/{{ revealButtonHref }}
https://github.com/angular/angularfire/pull/3838/files#diff-f1599226b85de4dcdf3a09df5814a2829bf7f635f4c92542915755a5d00b42db
https://github.com/angular/angularfire/pull/3838/files#diff-f1599226b85de4dcdf3a09df5814a2829bf7f635f4c92542915755a5d00b42db
https://github.com/angular/angularfire/pull/3838/files#diff-f1599226b85de4dcdf3a09df5814a2829bf7f635f4c92542915755a5d00b42db
https://github.com/angular/angularfire/pull/3838/files#diff-f1599226b85de4dcdf3a09df5814a2829bf7f635f4c92542915755a5d00b42db
docs/install-and-setup.mdhttps://github.com/angular/angularfire/pull/3838/files#diff-70728a44f408aaf005cff7035bf28d1480695b5bbab39b10ff8e34a7ec688464
View file https://github.com/armando-navarro/angularfire/blob/63283defba2629d16fb6b259781cb61daedc1446/docs/install-and-setup.md
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/angular/angularfire/pull/3838/{{ revealButtonHref }}
https://github.com/angular/angularfire/pull/3838/files#diff-70728a44f408aaf005cff7035bf28d1480695b5bbab39b10ff8e34a7ec688464
https://github.com/angular/angularfire/pull/3838/files#diff-70728a44f408aaf005cff7035bf28d1480695b5bbab39b10ff8e34a7ec688464
https://github.com/angular/angularfire/pull/3838/files#diff-70728a44f408aaf005cff7035bf28d1480695b5bbab39b10ff8e34a7ec688464
docs/version-7-upgrade.mdhttps://github.com/angular/angularfire/pull/3838/files#diff-850dbe65f991a788a906a5d910395205d2304f8b02402e9f566f30864c8cec0f
View file https://github.com/armando-navarro/angularfire/blob/63283defba2629d16fb6b259781cb61daedc1446/docs/version-7-upgrade.md
Open in desktop https://desktop.github.com
https://github.co/hiddenchars
https://github.com/angular/angularfire/pull/3838/{{ revealButtonHref }}
https://github.com/angular/angularfire/pull/3838/files#diff-850dbe65f991a788a906a5d910395205d2304f8b02402e9f566f30864c8cec0f
https://github.com/angular/angularfire/pull/3838/files#diff-850dbe65f991a788a906a5d910395205d2304f8b02402e9f566f30864c8cec0f
https://github.com/angular/angularfire/pull/3838/files#diff-850dbe65f991a788a906a5d910395205d2304f8b02402e9f566f30864c8cec0f
https://github.com/angular/angularfire/pull/3838/files#diff-850dbe65f991a788a906a5d910395205d2304f8b02402e9f566f30864c8cec0f
https://github.com/angular/angularfire/pull/3838/files#diff-850dbe65f991a788a906a5d910395205d2304f8b02402e9f566f30864c8cec0f
https://github.com/angular/angularfire/pull/3838/files#diff-850dbe65f991a788a906a5d910395205d2304f8b02402e9f566f30864c8cec0f
https://github.com/angular/angularfire/pull/3838/files#diff-850dbe65f991a788a906a5d910395205d2304f8b02402e9f566f30864c8cec0f
Please reload this pagehttps://github.com/angular/angularfire/pull/3838/files
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Response headers:
Servergithub.com
Content-Typetext/html; charset=utf-8
Cache-Controlno-cache

Viewport: width=device-width


URLs of crawlers that visited me.