-
Notifications
You must be signed in to change notification settings - Fork 873
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
Spelling #8280
Open
jsoref
wants to merge
156
commits into
firebase:master
Choose a base branch
from
jsoref:spelling
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Spelling #8280
Changes from all commits
Commits
Show all changes
156 commits
Select commit
Hold shift + click to select a range
e4feb53
spelling: absolute
jsoref 88f924a
spelling: actual
jsoref 0120f20
spelling: after
jsoref 4d1de68
spelling: aggregation
jsoref cfe6189
spelling: aggregations
jsoref a738546
spelling: async
jsoref 3d58d73
spelling: asynchronously
jsoref 24d5d4f
spelling: available
jsoref 2fce4f1
spelling: backslash
jsoref 54c1e35
spelling: behavior
jsoref 7bb7755
spelling: browser
jsoref c60982a
spelling: browsers
jsoref a81aa03
spelling: cannot
jsoref d19cca8
spelling: captcha
jsoref 4c2cb51
spelling: case-insensitive
jsoref ae527ca
spelling: case-sensitive
jsoref 16af10e
spelling: command
jsoref 9326ca4
spelling: complaining
jsoref b0c60e8
spelling: confirmation
jsoref db128ea
spelling: credentials
jsoref 5d17958
spelling: defaults
jsoref 3f9bf93
spelling: definition
jsoref 66e62d7
spelling: delay
jsoref 2bc8abd
spelling: dependent
jsoref 7f63620
spelling: deprecated
jsoref 650b8d1
spelling: different
jsoref 2812cfa
spelling: directly
jsoref 44cb400
spelling: disable
jsoref 886b5b7
spelling: documents
jsoref 6c1f774
spelling: download
jsoref 96a116b
spelling: duration
jsoref fc8e74e
spelling: eagerly
jsoref 14b932d
spelling: edge case
jsoref 6ee9f6b
spelling: efficient
jsoref a7a5dd3
spelling: embedded
jsoref bf030f0
spelling: endpoint
jsoref 19e2d81
spelling: enrollment
jsoref 0b4728d
spelling: environments
jsoref dfc998f
spelling: equivalent
jsoref 19ae545
spelling: essentially
jsoref 3288b7a
spelling: every time
jsoref c2d3ac2
spelling: factory
jsoref 9a9c63b
spelling: failure
jsoref 8f2e8b6
spelling: false
jsoref b991d32
spelling: field
jsoref ef2dafa
spelling: firebase
jsoref 0dfe37c
spelling: firestore
jsoref 2553969
spelling: flaky
jsoref 16e3eb5
spelling: fulfilled
jsoref 5b1e03f
spelling: function
jsoref d685e61
spelling: garbage
jsoref 59bb9f7
spelling: generated
jsoref cf92e22
spelling: github
jsoref 8956515
spelling: heartbeats
jsoref 28430b5
spelling: helpers
jsoref 12cfce7
spelling: ignore
jsoref 1f306ed
spelling: implementation
jsoref 620da37
spelling: implied
jsoref 74a3b1b
spelling: incorporates
jsoref 8bbeaac
spelling: indexed
jsoref e835d70
spelling: indices
jsoref a5dfd76
spelling: inheritance
jsoref 34fefe8
spelling: initialization
jsoref 3be3240
spelling: initialized
jsoref 5b6ea8b
spelling: installation
jsoref eb21009
spelling: instance
jsoref 17f3945
spelling: instanciation
jsoref de0ded1
spelling: instantiation
jsoref b0c85f7
spelling: instead
jsoref 880b197
spelling: instrumentation
jsoref 8fa8806
spelling: intermediate
jsoref e8e9553
spelling: invalidates
jsoref b4549f9
spelling: its
jsoref 039f2e2
spelling: javascript
jsoref ebe6cc0
spelling: keys
jsoref 940276f
spelling: legacy
jsoref a85c5af
spelling: less
jsoref 17587ff
spelling: lexicographic
jsoref 967bea0
spelling: lexicographical
jsoref 74ffc30
spelling: limit
jsoref 4801fa6
spelling: matching
jsoref 8b9d29e
spelling: message
jsoref bca106b
spelling: michael
jsoref 72acac6
spelling: monotonically
jsoref 81accdd
spelling: multi
jsoref ca3da37
spelling: multiple
jsoref 27e1257
spelling: neither-nor
jsoref 4870eb8
spelling: nonexistent
jsoref 469a71d
spelling: not
jsoref 7b7504d
spelling: number
jsoref 98ab5aa
spelling: occurrence
jsoref fc804ad
spelling: offline
jsoref 24bd9c9
spelling: omitted
jsoref 172e1bb
spelling: option
jsoref e295454
spelling: optional
jsoref 7c56997
spelling: order
jsoref 0053165
spelling: otherwise
jsoref 42dde17
spelling: overridden
jsoref 1f82f77
spelling: packages
jsoref f1039d1
spelling: performance
jsoref 3d23112
spelling: perpetually
jsoref 027f7fc
spelling: persistence
jsoref 6fba97b
spelling: populated
jsoref af098c5
spelling: predictable
jsoref 4f84093
spelling: preexisting
jsoref 8e169a6
spelling: profile
jsoref a58d534
spelling: programmatically
jsoref ed44b0c
spelling: promisified
jsoref d8253c0
spelling: protected
jsoref f953edb
spelling: racy
jsoref 32930f6
spelling: random
jsoref 814cab4
spelling: recaptcha
jsoref 7b4b175
spelling: received
jsoref 03f44dd
spelling: recognition
jsoref 6bdcb1c
spelling: registered
jsoref ffe28f7
spelling: registry
jsoref 6caa369
spelling: removed
jsoref fc2a980
spelling: response
jsoref 67dea41
spelling: retrieved
jsoref 6874f14
spelling: retrieves
jsoref ca8c36c
spelling: sampling
jsoref a5c724e
spelling: seconds
jsoref d38cc50
spelling: separated
jsoref 36f65df
spelling: service
jsoref 1a13481
spelling: signature
jsoref 9bb11e2
spelling: skipping
jsoref 5b8ab4b
spelling: snapshot
jsoref 3f64a9a
spelling: specified
jsoref 405007f
spelling: statement
jsoref 85a71dd
spelling: successful
jsoref 88cafda
spelling: supporting
jsoref ff134fb
spelling: synced
jsoref 6a7181d
spelling: synchronization
jsoref 3e8a4b1
spelling: synchronously
jsoref 466a970
spelling: that
jsoref 54683d2
spelling: the
jsoref 8613867
spelling: thenable
jsoref 677b299
spelling: timeout
jsoref 9fd0241
spelling: todo
jsoref 3460314
spelling: trailing
jsoref 3c0b7f7
spelling: transaction
jsoref d57069d
spelling: typescript
jsoref c1fcd66
spelling: unexpectedly
jsoref d89bae3
spelling: unloaded
jsoref f437aa5
spelling: users
jsoref 680cd25
spelling: variable
jsoref fdb52cd
spelling: verification
jsoref 2c667bc
spelling: verifier
jsoref 26472c9
spelling: version
jsoref cb750cc
spelling: vomiting
jsoref ecbf611
spelling: whether the
jsoref dad9685
spelling: will
jsoref 2cbbf67
spelling: with
jsoref 784cb8c
spelling: workspace
jsoref 1fdeac7
spelling: wrapper
jsoref 807016c
spelling: constructor [API]
jsoref File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -98,8 +98,8 @@ https://github.com/firebase/firebase-js-sdk | |
| [or(queryConstraints)](./firestore_.md#or_e72c712) | Creates a new [QueryCompositeFilterConstraint](./firestore_.querycompositefilterconstraint.md#querycompositefilterconstraint_class) that is a disjunction of the given filter constraints. A disjunction filter includes a document if it satisfies any of the given filters. | | ||
| <b>function(reference, ...)</b> | | ||
| [addDoc(reference, data)](./firestore_.md#adddoc_6e783ff) | Add a new document to specified <code>CollectionReference</code> with the given data, assigning it a document ID automatically. | | ||
| [collection(reference, path, pathSegments)](./firestore_.md#collection_568f98d) | Gets a <code>CollectionReference</code> instance that refers to a subcollection of <code>reference</code> at the the specified relative path. | | ||
| [collection(reference, path, pathSegments)](./firestore_.md#collection_70b4396) | Gets a <code>CollectionReference</code> instance that refers to a subcollection of <code>reference</code> at the the specified relative path. | | ||
| [collection(reference, path, pathSegments)](./firestore_.md#collection_568f98d) | Gets a <code>CollectionReference</code> instance that refers to a subcollection of <code>reference</code> at the specified relative path. | | ||
| [collection(reference, path, pathSegments)](./firestore_.md#collection_70b4396) | Gets a <code>CollectionReference</code> instance that refers to a subcollection of <code>reference</code> at the specified relative path. | | ||
| [deleteDoc(reference)](./firestore_.md#deletedoc_4569087) | Deletes the document referred to by the specified <code>DocumentReference</code>. | | ||
| [doc(reference, path, pathSegments)](./firestore_.md#doc_568f98d) | Gets a <code>DocumentReference</code> instance that refers to a document within <code>reference</code> at the specified relative path. If no path is specified, an automatically-generated unique ID will be used for the returned <code>DocumentReference</code>. | | ||
| [doc(reference, path, pathSegments)](./firestore_.md#doc_70b4396) | Gets a <code>DocumentReference</code> instance that refers to a document within <code>reference</code> at the specified relative path. | | ||
|
@@ -179,7 +179,7 @@ https://github.com/firebase/firebase-js-sdk | |
| [PersistentCacheSettings](./firestore_.persistentcachesettings.md#persistentcachesettings_interface) | An settings object to configure an <code>PersistentLocalCache</code> instance.<!-- -->Persistent cache cannot be used in a Node.js environment. | | ||
| [PersistentLocalCache](./firestore_.persistentlocalcache.md#persistentlocalcache_interface) | Provides a persistent cache backed by IndexedDb to the SDK.<!-- -->To use, create an instance using the factory function , then set the instance to <code>FirestoreSettings.cache</code> and call <code>initializeFirestore</code> using the settings object. | | ||
| [PersistentMultipleTabManager](./firestore_.persistentmultipletabmanager.md#persistentmultipletabmanager_interface) | A tab manager supporting multiple tabs. SDK will synchronize queries and mutations done across all tabs using the SDK. | | ||
| [PersistentSingleTabManager](./firestore_.persistentsingletabmanager.md#persistentsingletabmanager_interface) | A tab manager supportting only one tab, no synchronization will be performed across tabs. | | ||
| [PersistentSingleTabManager](./firestore_.persistentsingletabmanager.md#persistentsingletabmanager_interface) | A tab manager supporting only one tab, no synchronization will be performed across tabs. | | ||
| [PersistentSingleTabManagerSettings](./firestore_.persistentsingletabmanagersettings.md#persistentsingletabmanagersettings_interface) | Type to configure an <code>PersistentSingleTabManager</code> instance. | | ||
| [SnapshotListenOptions](./firestore_.snapshotlistenoptions.md#snapshotlistenoptions_interface) | An options object that can be passed to [onSnapshot()](./firestore_.md#onsnapshot_0312fd7) and [QuerySnapshot.docChanges()](./firestore_.querysnapshot.md#querysnapshotdocchanges) to control which types of changes to include in the result set. | | ||
| [SnapshotOptions](./firestore_.snapshotoptions.md#snapshotoptions_interface) | Options that configure how data is retrieved from a <code>DocumentSnapshot</code> (for example the desired behavior for server timestamps that have not yet been set to their final value). | | ||
|
@@ -205,10 +205,10 @@ https://github.com/firebase/firebase-js-sdk | |
| [FirestoreErrorCode](./firestore_.md#firestoreerrorcode) | The set of Firestore status codes. The codes are the same at the ones exposed by gRPC here: https://github.com/grpc/grpc/blob/master/doc/statuscodes.md<!-- -->Possible values: - 'cancelled': The operation was cancelled (typically by the caller). - 'unknown': Unknown error or an error from a different error domain. - 'invalid-argument': Client specified an invalid argument. Note that this differs from 'failed-precondition'. 'invalid-argument' indicates arguments that are problematic regardless of the state of the system (e.g. an invalid field name). - 'deadline-exceeded': Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire. - 'not-found': Some requested document was not found. - 'already-exists': Some document that we attempted to create already exists. - 'permission-denied': The caller does not have permission to execute the specified operation. - 'resource-exhausted': Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space. - 'failed-precondition': Operation was rejected because the system is not in a state required for the operation's execution. - 'aborted': The operation was aborted, typically due to a concurrency issue like transaction aborts, etc. - 'out-of-range': Operation was attempted past the valid range. - 'unimplemented': Operation is not implemented or not supported/enabled. - 'internal': Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken. - 'unavailable': The service is currently unavailable. This is most likely a transient condition and may be corrected by retrying with a backoff. - 'data-loss': Unrecoverable data loss or corruption. - 'unauthenticated': The request does not have valid authentication credentials for the operation. | | ||
| [FirestoreLocalCache](./firestore_.md#firestorelocalcache) | Union type from all supported SDK cache layer. | | ||
| [ListenSource](./firestore_.md#listensource) | Describe the source a query listens to.<!-- -->Set to <code>default</code> to listen to both cache and server changes. Set to <code>cache</code> to listen to changes in cache only. | | ||
| [MemoryGarbageCollector](./firestore_.md#memorygarbagecollector) | Union type from all support gabage collectors for memory local cache. | | ||
| [MemoryGarbageCollector](./firestore_.md#memorygarbagecollector) | Union type from all support garbage collectors for memory local cache. | | ||
| [NestedUpdateFields](./firestore_.md#nestedupdatefields) | For each field (e.g. 'bar'), find all nested keys (e.g. {<!-- -->'bar.baz': T1, 'bar.qux': T2<!-- -->}<!-- -->). Intersect them together to make a single map containing all possible keys that are all marked as optional | | ||
| [OrderByDirection](./firestore_.md#orderbydirection) | The direction of a [orderBy()](./firestore_.md#orderby_006d61f) clause is specified as 'desc' or 'asc' (descending or ascending). | | ||
| [PartialWithFieldValue](./firestore_.md#partialwithfieldvalue) | Similar to Typescript's <code>Partial<T></code>, but allows nested fields to be omitted and FieldValues to be passed in as property values. | | ||
| [PartialWithFieldValue](./firestore_.md#partialwithfieldvalue) | Similar to TypeScript's <code>Partial<T></code>, but allows nested fields to be omitted and FieldValues to be passed in as property values. | | ||
| [PersistentTabManager](./firestore_.md#persistenttabmanager) | A union of all available tab managers. | | ||
| [Primitive](./firestore_.md#primitive) | Primitive types. | | ||
| [QueryConstraintType](./firestore_.md#queryconstrainttype) | Describes the different query constraints available in this SDK. | | ||
|
@@ -1863,7 +1863,7 @@ A `Promise` resolved with a `DocumentReference` pointing to the newly created do | |
|
||
### collection(reference, path, pathSegments) {:#collection_568f98d} | ||
|
||
Gets a `CollectionReference` instance that refers to a subcollection of `reference` at the the specified relative path. | ||
Gets a `CollectionReference` instance that refers to a subcollection of `reference` at the specified relative path. | ||
|
||
<b>Signature:</b> | ||
|
||
|
@@ -1891,7 +1891,7 @@ If the final path has an even number of segments and does not point to a collect | |
|
||
### collection(reference, path, pathSegments) {:#collection_70b4396} | ||
|
||
Gets a `CollectionReference` instance that refers to a subcollection of `reference` at the the specified relative path. | ||
Gets a `CollectionReference` instance that refers to a subcollection of `reference` at the specified relative path. | ||
|
||
<b>Signature:</b> | ||
|
||
|
@@ -1954,7 +1954,7 @@ export declare function doc<AppModelType, DbModelType extends DocumentData>(refe | |
| Parameter | Type | Description | | ||
| --- | --- | --- | | ||
| reference | [CollectionReference](./firestore_.collectionreference.md#collectionreference_class)<!-- --><AppModelType, DbModelType> | A reference to a collection. | | ||
| path | string | A slash-separated path to a document. Has to be omitted to use auto-genrated IDs. | | ||
| path | string | A slash-separated path to a document. Has to be omitted to use auto-generated IDs. | | ||
| pathSegments | string\[\] | Additional path segments that will be applied relative to the first argument. | | ||
|
||
<b>Returns:</b> | ||
|
@@ -2566,7 +2566,7 @@ export declare type ListenSource = 'default' | 'cache'; | |
|
||
## MemoryGarbageCollector | ||
|
||
Union type from all support gabage collectors for memory local cache. | ||
Union type from all support garbage collectors for memory local cache. | ||
|
||
<b>Signature:</b> | ||
|
||
|
@@ -2598,7 +2598,7 @@ export declare type OrderByDirection = 'desc' | 'asc'; | |
|
||
## PartialWithFieldValue | ||
|
||
Similar to Typescript's `Partial<T>`<!-- -->, but allows nested fields to be omitted and FieldValues to be passed in as property values. | ||
Similar to TypeScript's `Partial<T>`<!-- -->, but allows nested fields to be omitted and FieldValues to be passed in as property values. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. brand |
||
|
||
<b>Signature:</b> | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
brand