Skip to content

Hide converter from Public API #3794

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.

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

Merged
merged 1 commit into from
Sep 16, 2020
Merged

Conversation

schmidt-sebastian
Copy link
Contributor

The converter property is currently not part of our public API, and as such it should be prefixed with an underscore

This is firestore-exp/lite only.

The converter property is currently not part of our public API, and as such it should be prefixed with an underscore
@changeset-bot
Copy link

changeset-bot bot commented Sep 16, 2020

💥 No Changeset

Latest commit: ba1e940

Merging this PR will not cause any packages to be released. If these changes should not cause updates to packages in this repo, this is fine 🙂

If these changes should be published to npm, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@google-oss-bot
Copy link
Contributor

Binary Size Report

Affected SDKs

  • @firebase/firestore/exp

    Type Base (07cbd42) Head (b36c9e7) Diff
    browser 189 kB 189 kB -122 B (-0.1%)
    main 478 kB 478 kB -7 B (-0.0%)
    module 189 kB 189 kB -122 B (-0.1%)
    react-native 189 kB 189 kB -122 B (-0.1%)
  • @firebase/firestore/lite

    Type Base (07cbd42) Head (b36c9e7) Diff
    browser 64.0 kB 63.8 kB -115 B (-0.2%)
    main 141 kB 141 kB -8 B (-0.0%)
    module 64.0 kB 63.8 kB -115 B (-0.2%)
    react-native 64.2 kB 64.1 kB -115 B (-0.2%)

Test Logs

@google-oss-bot
Copy link
Contributor

Size Analysis Report

Affected Products

No changes between base commit (07cbd42) and head commit (b36c9e7).

Test Logs

@@ -108,10 +108,10 @@ export class DocumentReference<T = DocumentData> extends _DocumentKeyReference<

constructor(
readonly firestore: FirebaseFirestore,
readonly converter: FirestoreDataConverter<T> | null,
_converter: FirestoreDataConverter<T> | null,

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why does this need to have its readonly property removed? I don't see the converter value being assigned to a new value anywhere.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The readonly is already part of the parent class, which already uses the underscore naming.

Copy link

@thebrianchen thebrianchen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm w/ question

@schmidt-sebastian schmidt-sebastian merged commit 40f9582 into master Sep 16, 2020
@firebase firebase locked and limited conversation to collaborators Oct 17, 2020
@schmidt-sebastian schmidt-sebastian deleted the mrschmidt/underscore branch November 9, 2020 22:38
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants