-
Notifications
You must be signed in to change notification settings - Fork 938
Spelling #8280
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
+426
−418
Merged
Spelling #8280
Changes from all commits
Commits
Show all changes
159 commits
Select commit
Hold shift + click to select a range
f36a4b3
spelling: absolute
jsoref 8750cec
spelling: actual
jsoref ec869c3
spelling: after
jsoref 01573e3
spelling: aggregation
jsoref 87f0d7b
spelling: aggregations
jsoref b3f64c3
spelling: async
jsoref 6efb688
spelling: asynchronously
jsoref dc5a600
spelling: available
jsoref b18ed24
spelling: backslash
jsoref 30b41ff
spelling: behavior
jsoref a1dd174
spelling: browser
jsoref 988c5d7
spelling: browsers
jsoref 775c665
spelling: cannot
jsoref 7e3ff93
spelling: captcha
jsoref 5dc7a17
spelling: case-insensitive
jsoref 05d0bda
spelling: case-sensitive
jsoref c06b1ef
spelling: command
jsoref 73d7787
spelling: complaining
jsoref 665fd79
spelling: confirmation
jsoref 24ff00f
spelling: credentials
jsoref 83e1555
spelling: defaults
jsoref 8e7f281
spelling: definition
jsoref a3df13e
spelling: delay
jsoref 46b0154
spelling: dependent
jsoref 325993b
spelling: deprecated
jsoref 852bc8e
spelling: different
jsoref b278399
spelling: directly
jsoref bc9f510
spelling: documents
jsoref 239e334
spelling: download
jsoref a4f725a
spelling: duration
jsoref 6037a3e
spelling: eagerly
jsoref c9f70fa
spelling: edge case
jsoref b853f5a
spelling: efficient
jsoref f036ee2
spelling: embedded
jsoref bd3660b
spelling: enable
jsoref 88afe7c
spelling: endpoint
jsoref c37283b
spelling: enrollment
jsoref 67faccb
spelling: environments
jsoref 2f3b189
spelling: equivalent
jsoref 2188cbb
spelling: essentially
jsoref 6f14a8b
spelling: every time
jsoref 79162d1
spelling: factory
jsoref a55a378
spelling: failure
jsoref 06e0250
spelling: false
jsoref df5b879
spelling: field
jsoref 2213fdf
spelling: firebase
jsoref 0f99219
spelling: firestore
jsoref 8e1f134
spelling: flaky
jsoref bbf3135
spelling: fulfilled
jsoref 9cdf91b
spelling: function
jsoref 5d4693a
spelling: garbage
jsoref 63460de
spelling: generated
jsoref ae6b448
spelling: github
jsoref b8eb1bb
spelling: heartbeats
jsoref 3473090
spelling: helpers
jsoref e7bdcac
spelling: ignore
jsoref d9cef3a
spelling: implementation
jsoref 246dc3b
spelling: implied
jsoref 6c08de4
spelling: incorporates
jsoref 3cae65a
spelling: indexed
jsoref b86ee42
spelling: indices
jsoref 57222f6
spelling: inheritance
jsoref 01493d8
spelling: initialization
jsoref 58678a1
spelling: initialized
jsoref 5aeb742
spelling: installation
jsoref a42ea77
spelling: instance
jsoref abafcaa
spelling: instanciation
jsoref bceba22
spelling: instantiation
jsoref 8705233
spelling: instead
jsoref 022358e
spelling: instrumentation
jsoref 05b3724
spelling: intermediate
jsoref a812ef8
spelling: invalidates
jsoref cbc7d75
spelling: its
jsoref 0ded403
spelling: javascript
jsoref 51aca25
spelling: keys
jsoref a0bcb66
spelling: legacy
jsoref 796fa32
spelling: less
jsoref c931cf3
spelling: lexicographic
jsoref 2cbd5e1
spelling: lexicographical
jsoref 227a99e
spelling: limit
jsoref 8f4051b
spelling: matching
jsoref eeb632e
spelling: message
jsoref d16f275
spelling: michael
jsoref 0e3fd14
spelling: monotonically
jsoref 5a90738
spelling: multi
jsoref a15444b
spelling: multiple
jsoref 7e90bb7
spelling: neither-nor
jsoref 115220d
spelling: nonexistent
jsoref 6eec676
spelling: not
jsoref 362d06d
spelling: number
jsoref 7811422
spelling: occurrence
jsoref 1bb2ebd
spelling: offline
jsoref ed163fd
spelling: omitted
jsoref 707e493
spelling: option
jsoref 75edfd0
spelling: optional
jsoref 1bb577e
spelling: order
jsoref aa7e38d
spelling: otherwise
jsoref 572e30a
spelling: overridden
jsoref cedf9ca
spelling: packages
jsoref f028806
spelling: performance
jsoref 7a52506
spelling: perpetually
jsoref a847ca4
spelling: persistence
jsoref eb43e2a
spelling: populated
jsoref 7107475
spelling: predictable
jsoref 492ce93
spelling: preexisting
jsoref 3477b52
spelling: profile
jsoref d4e4ebd
spelling: programmatically
jsoref 62156fd
spelling: promisified
jsoref d9ae4ae
spelling: protected
jsoref 49c94f9
spelling: racy
jsoref 88ab991
spelling: random
jsoref e2c5e8e
spelling: recaptcha
jsoref f2025c2
spelling: received
jsoref 2b8adfc
spelling: recognition
jsoref 90f0416
spelling: registered
jsoref 992da7d
spelling: registry
jsoref 3719783
spelling: removed
jsoref 438f843
spelling: response
jsoref a9c3329
spelling: retrieved
jsoref b57bfcc
spelling: retrieves
jsoref 18c9494
spelling: sampling
jsoref 07c14b3
spelling: seconds
jsoref 48ee962
spelling: separated
jsoref 4949d80
spelling: service
jsoref 8e67ad1
spelling: signature
jsoref 0a58376
spelling: skipping
jsoref 847d4ef
spelling: snapshot
jsoref 26ef081
spelling: specified
jsoref 16e063a
spelling: statement
jsoref c564f39
spelling: successful
jsoref 228664b
spelling: supporting
jsoref 288b88f
spelling: synced
jsoref 7b239f6
spelling: synchronization
jsoref a4c3138
spelling: synchronously
jsoref c25b836
spelling: that
jsoref d50367a
spelling: the
jsoref 4dde093
spelling: thenable
jsoref 97451c1
spelling: timeout
jsoref 956d550
spelling: todo
jsoref 3a1994c
spelling: trailing
jsoref ff76055
spelling: transaction
jsoref 5a05ae8
spelling: typescript
jsoref 69070ef
spelling: unexpectedly
jsoref a09d032
spelling: unloaded
jsoref df4d39f
spelling: users
jsoref 56b1922
spelling: variable
jsoref 6f6d679
spelling: verification
jsoref 37f7066
spelling: verifier
jsoref 5deb5c8
spelling: version
jsoref c39c66f
spelling: vomiting
jsoref 23bae80
spelling: whether the
jsoref d329e57
spelling: will
jsoref 761d57d
spelling: with
jsoref 55f752c
spelling: workspace
jsoref f45dfda
spelling: wrapper
jsoref 0d192d1
spelling: constructor [API]
jsoref 7e68f0f
docs
DellaBitta 8433b90
changeset
DellaBitta eeb89cc
update changeset package list to represent code changes only.
DellaBitta 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 hidden or 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 |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
'@firebase/firestore-compat': patch | ||
'@firebase/database-compat': patch | ||
'@firebase/auth-compat': patch | ||
'@firebase/app-compat': patch | ||
'@firebase/firestore': patch | ||
'@firebase/database': patch | ||
'firebase': patch | ||
'@firebase/auth': patch |
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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.
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.
Uh oh!
There was an error while loading. Please reload this page.