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.

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

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

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .changeset/late-humans-tan.md
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
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ root = true
end_of_line = lf
insert_final_newline = true

# Javascript and Typescript look like Google-style
# JavaScript and TypeScript look like Google-style
[*.{js,json,ts}]
charset = utf-8
indent_style = space
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report_v2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ body:
attributes:
value: |
*[READ THIS]:* to evaluate if you are in the right place?
- For issues or feature requests related to __the code in this repository__, file a Github issue.
- For issues or feature requests related to __the code in this repository__, file a GitHub issue.
jsoref marked this conversation as resolved.
Show resolved Hide resolved
- If this is a __feature request__, make sure the issue title starts with "FR:".
- For general technical questions, post a question on [StackOverflow](http://stackoverflow.com/) with the firebase tag.
- For general Firebase discussion, use the [firebase-talk](https://groups.google.com/forum/#!forum/firebase-talk) google group.
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release-prod.yml
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ jobs:
curl -X POST -H "Content-Type:application/json" \
-d "{\"version\":\"$BASE_VERSION\",\"date\":\"$DATE\"}" \
$RELEASE_TRACKER_URL/logProduction
- name: Create Github release
- name: Create GitHub release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test-all.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ env:
# make chromedriver detect installed Chrome version and download the corresponding driver
DETECT_CHROMEDRIVER_VERSION: true
# The default behavior of chromedriver uses the older Chrome download URLs. We need to override
# the beahvior to use the new URLs.
# the behavior to use the new URLs.
CHROMEDRIVER_CDNURL: https://googlechromelabs.github.io/
CHROMEDRIVER_CDNBINARIESURL: https://storage.googleapis.com/chrome-for-testing-public
CHROME_VALIDATED_VERSION: linux-120.0.6099.71
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/test-changed-auth.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ env:
# make chromedriver detect installed Chrome version and download the corresponding driver
DETECT_CHROMEDRIVER_VERSION: true
# The default behavior of chromedriver uses the older Chrome download URLs. We need to override
# the beahvior to use the new URLs.
# the behavior to use the new URLs.
CHROMEDRIVER_CDNURL: https://googlechromelabs.github.io/
CHROMEDRIVER_CDNBINARIESURL: https://storage.googleapis.com/chrome-for-testing-public
CHROME_VALIDATED_VERSION: linux-120.0.6099.71
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Firebase Javascript SDK
# Firebase JavaScript SDK

<!-- BADGES -->
![Build Status](https://img.shields.io/github/actions/workflow/status/firebase/firebase-js-sdk/test-all.yml)
Expand Down
2 changes: 1 addition & 1 deletion config/api-extractor.json
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@
*/
"default": {
/**
* Specifies whether the message should be written to the the tool's output log. Note that
* Specifies whether the message should be written to the tool's output log. Note that
* the "addToApiReportFile" property may supersede this option.
*
* Possible values: "error", "warning", "none"
Expand Down
2 changes: 1 addition & 1 deletion config/karma.saucelabs.js
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ function getPackageLabels() {

/**
* Gets a list of file patterns for test, defined individually
* in karma.conf.js in each package under worksapce packages or
* in karma.conf.js in each package under workspace packages or
* integration.
*/
function getTestFiles() {
Expand Down
10 changes: 5 additions & 5 deletions docs-devsite/auth.githubauthprovider.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ export declare class GithubAuthProvider extends BaseOAuthProvider

| Method | Modifiers | Description |
| --- | --- | --- |
| [credential(accessToken)](./auth.githubauthprovider.md#githubauthprovidercredential) | <code>static</code> | Creates a credential for Github. |
| [credential(accessToken)](./auth.githubauthprovider.md#githubauthprovidercredential) | <code>static</code> | Creates a credential for GitHub. |
| [credentialFromError(error)](./auth.githubauthprovider.md#githubauthprovidercredentialfromerror) | <code>static</code> | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md#oauthcredential_class) from a [AuthError](./auth.autherror.md#autherror_interface) which was thrown during a sign-in, link, or reauthenticate operation. |
| [credentialFromResult(userCredential)](./auth.githubauthprovider.md#githubauthprovidercredentialfromresult) | <code>static</code> | Used to extract the underlying [OAuthCredential](./auth.oauthcredential.md#oauthcredential_class) from a [UserCredential](./auth.usercredential.md#usercredential_interface)<!-- -->. |

Expand Down Expand Up @@ -74,7 +74,7 @@ static readonly PROVIDER_ID: 'github.com';

## GithubAuthProvider.credential()

Creates a credential for Github.
Creates a credential for GitHub.

<b>Signature:</b>

Expand All @@ -86,7 +86,7 @@ static credential(accessToken: string): OAuthCredential;

| Parameter | Type | Description |
| --- | --- | --- |
| accessToken | string | Github access token. |
| accessToken | string | GitHub access token. |

<b>Returns:</b>

Expand Down Expand Up @@ -148,7 +148,7 @@ const result = await getRedirectResult(auth);
if (result) {
// This is the signed-in user
const user = result.user;
// This gives you a Github Access Token.
// This gives you a GitHub Access Token.
const credential = GithubAuthProvider.credentialFromResult(result);
const token = credential.accessToken;
}
Expand All @@ -166,7 +166,7 @@ const result = await signInWithPopup(auth, provider);

// The signed-in user info.
const user = result.user;
// This gives you a Github Access Token.
// This gives you a GitHub Access Token.
const credential = GithubAuthProvider.credentialFromResult(result);
const token = credential.accessToken;

Expand Down
4 changes: 2 additions & 2 deletions docs-devsite/database.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Firebase Realtime Database
| Function | Description |
| --- | --- |
| <b>function(app, ...)</b> |
| [getDatabase(app, url)](./database.md#getdatabase_d9cea01) | Returns the instance of the Realtime Database SDK that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. Initializes a new instance with with default settings if no instance exists or if the existing instance uses a custom database URL. |
| [getDatabase(app, url)](./database.md#getdatabase_d9cea01) | Returns the instance of the Realtime Database SDK that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. Initializes a new instance with default settings if no instance exists or if the existing instance uses a custom database URL. |
| <b>function(db, ...)</b> |
| [connectDatabaseEmulator(db, host, port, options)](./database.md#connectdatabaseemulator_27b9e93) | Modify the provided instance to communicate with the Realtime Database emulator.<p>Note: This method must be called before performing any other operation. |
| [goOffline(db)](./database.md#gooffline_732b338) | Disconnects from the server (all Database operations will be completed offline).<!-- -->The client automatically maintains a persistent connection to the Database server, which will remain active indefinitely and reconnect when disconnected. However, the <code>goOffline()</code> and <code>goOnline()</code> methods may be used to control the client connection in cases where a persistent connection is undesirable.<!-- -->While offline, the client will no longer receive data updates from the Database. However, all Database operations performed locally will continue to immediately fire events, allowing your application to continue behaving normally. Additionally, each operation performed locally will automatically be queued and retried upon reconnection to the Database server.<!-- -->To reconnect to the Database and begin receiving remote events, see <code>goOnline()</code>. |
Expand Down Expand Up @@ -112,7 +112,7 @@ Firebase Realtime Database

### getDatabase(app, url) {:#getdatabase_d9cea01}

Returns the instance of the Realtime Database SDK that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. Initializes a new instance with with default settings if no instance exists or if the existing instance uses a custom database URL.
Returns the instance of the Realtime Database SDK that is associated with the provided [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface)<!-- -->. Initializes a new instance with default settings if no instance exists or if the existing instance uses a custom database URL.

<b>Signature:</b>

Expand Down
20 changes: 10 additions & 10 deletions docs-devsite/firestore_.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. |
Expand Down Expand Up @@ -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). |
Expand All @@ -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&lt;T&gt;</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&lt;T&gt;</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. |
Expand Down Expand Up @@ -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>

Expand Down Expand Up @@ -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>

Expand Down Expand Up @@ -1954,7 +1954,7 @@ export declare function doc<AppModelType, DbModelType extends DocumentData>(refe
| Parameter | Type | Description |
| --- | --- | --- |
| reference | [CollectionReference](./firestore_.collectionreference.md#collectionreference_class)<!-- -->&lt;AppModelType, DbModelType&gt; | 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>
Expand Down Expand Up @@ -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>

Expand Down Expand Up @@ -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.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

brand


<b>Signature:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs-devsite/firestore_.persistentsingletabmanager.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# PersistentSingleTabManager interface
A tab manager supportting only one tab, no synchronization will be performed across tabs.
A tab manager supporting only one tab, no synchronization will be performed across tabs.

<b>Signature:</b>

Expand Down
Loading
Loading