You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs-devsite/auth.githubauthprovider.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ export declare class GithubAuthProvider extends BaseOAuthProvider
38
38
39
39
| Method | Modifiers | Description |
40
40
| --- | --- | --- |
41
-
| [credential(accessToken)](./auth.githubauthprovider.md#githubauthprovidercredential) | <code>static</code> | Creates a credential for Github. |
41
+
| [credential(accessToken)](./auth.githubauthprovider.md#githubauthprovidercredential) | <code>static</code> | Creates a credential for GitHub. |
42
42
| [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. |
43
43
| [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)<!-- -->. |
Copy file name to clipboardexpand all lines: docs-devsite/database.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,7 @@ Firebase Realtime Database
17
17
| Function | Description |
18
18
| --- | --- |
19
19
| <b>function(app, ...)</b> |
20
-
|[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. |
20
+
|[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. |
21
21
| <b>function(db, ...)</b> |
22
22
|[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. |
23
23
|[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>. |
@@ -112,7 +112,7 @@ Firebase Realtime Database
112
112
113
113
### getDatabase(app, url) {:#getdatabase_d9cea01}
114
114
115
-
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.
115
+
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.
|[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. |
99
99
| <b>function(reference, ...)</b> |
100
100
|[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. |
101
-
|[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. |
102
-
|[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. |
101
+
|[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. |
102
+
|[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. |
103
103
|[deleteDoc(reference)](./firestore_.md#deletedoc_4569087)| Deletes the document referred to by the specified <code>DocumentReference</code>. |
104
104
|[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>. |
105
105
|[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. |
|[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. |
180
180
|[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. |
181
181
|[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. |
182
-
|[PersistentSingleTabManager](./firestore_.persistentsingletabmanager.md#persistentsingletabmanager_interface)| A tab manager supportting only one tab, no synchronization will be performed across tabs. |
182
+
|[PersistentSingleTabManager](./firestore_.persistentsingletabmanager.md#persistentsingletabmanager_interface)| A tab manager supporting only one tab, no synchronization will be performed across tabs. |
183
183
|[PersistentSingleTabManagerSettings](./firestore_.persistentsingletabmanagersettings.md#persistentsingletabmanagersettings_interface)| Type to configure an <code>PersistentSingleTabManager</code> instance. |
184
184
|[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. |
185
185
|[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). |
| [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. |
206
206
|[FirestoreLocalCache](./firestore_.md#firestorelocalcache)| Union type from all supported SDK cache layer. |
207
207
|[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. |
208
-
|[MemoryGarbageCollector](./firestore_.md#memorygarbagecollector)| Union type from all support gabage collectors for memory local cache. |
208
+
|[MemoryGarbageCollector](./firestore_.md#memorygarbagecollector)| Union type from all support garbage collectors for memory local cache. |
209
209
|[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 |
210
210
|[OrderByDirection](./firestore_.md#orderbydirection)| The direction of a [orderBy()](./firestore_.md#orderby_006d61f) clause is specified as 'desc' or 'asc' (descending or ascending). |
211
-
|[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. |
211
+
|[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. |
212
212
|[PersistentTabManager](./firestore_.md#persistenttabmanager)| A union of all available tab managers. |
| reference |[CollectionReference](./firestore_.collectionreference.md#collectionreference_class)<!----><AppModelType, DbModelType>| A reference to a collection. |
1957
-
| path | string | A slash-separated path to a document. Has to be omitted to use auto-genrated IDs. |
1957
+
| path | string | A slash-separated path to a document. Has to be omitted to use auto-generated IDs. |
1958
1958
| pathSegments | string\[\]| Additional path segments that will be applied relative to the first argument. |
0 commit comments