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
|[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
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. |
| 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. |
| reference |[CollectionReference](./firestore_lite.collectionreference.md#collectionreference_class)<!----><AppModelType, DbModelType>| A reference to a collection. |
1295
-
| path | string | A slash-separated path to a document. Has to be omitted to use auto-genrated IDs. |
1295
+
| path | string | A slash-separated path to a document. Has to be omitted to use auto-generated IDs. |
1296
1296
| pathSegments | string\[\]| Additional path segments that will be applied relative to the first argument. |
Copy file name to clipboardExpand all lines: docs-devsite/storage.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -26,7 +26,7 @@ Cloud Storage for Firebase
26
26
|[getBlob(ref, maxDownloadSizeBytes)](./storage.md#getblob_1c7a935)| Downloads the data at the object's location. Returns an error if the object is not found.<!---->To use this functionality, you have to whitelist your app's origin in your Cloud Storage bucket. See also https://cloud.google.com/storage/docs/configuring-cors<!---->This API is not available in Node. |
27
27
|[getBytes(ref, maxDownloadSizeBytes)](./storage.md#getbytes_1c7a935)| Downloads the data at the object's location. Returns an error if the object is not found.<!---->To use this functionality, you have to whitelist your app's origin in your Cloud Storage bucket. See also https://cloud.google.com/storage/docs/configuring-cors|
28
28
|[getDownloadURL(ref)](./storage.md#getdownloadurl_30df0b2)| Returns the download URL for the given [StorageReference](./storage.storagereference.md#storagereference_interface)<!---->. |
29
-
|[getMetadata(ref)](./storage.md#getmetadata_30df0b2)| A <code>Promise</code> that resolves with the metadata for this object. If this object doesn't exist or metadata cannot be retreived, the promise is rejected. |
29
+
|[getMetadata(ref)](./storage.md#getmetadata_30df0b2)| A <code>Promise</code> that resolves with the metadata for this object. If this object doesn't exist or metadata cannot be retrieved, the promise is rejected. |
30
30
|[getStream(ref, maxDownloadSizeBytes)](./storage.md#getstream_1c7a935)| Downloads the data at the object's location. Raises an error event if the object is not found.<!---->This API is only available in Node. |
31
31
|[list(ref, options)](./storage.md#list_36af757)| List items (files) and prefixes (folders) under this storage reference.<!---->List API is only available for Firebase Rules Version 2.<!---->GCS is a key-blob store. Firebase Storage imposes the semantic of '/' delimited folder structure. Refer to GCS's List API if you want to learn more.<!---->To adhere to Firebase Rules's Semantics, Firebase Storage does not support objects whose paths end with "/" or contain two consecutive "/"s. Firebase Storage List API will filter these unsupported objects. list() may fail if there are too many unsupported objects in the bucket. |
32
32
|[listAll(ref)](./storage.md#listall_30df0b2)| List all items (files) and prefixes (folders) under this storage reference.<!---->This is a helper method for calling list() repeatedly until there are no more results. The default pagination size is 1000.<!---->Note: The results may not be consistent if objects are changed while this operation is running.<!---->Warning: <code>listAll</code> may potentially consume too many resources if there are too many results. |
@@ -252,7 +252,7 @@ A `Promise` that resolves with the download URL for this object.
252
252
253
253
### getMetadata(ref) {:#getmetadata_30df0b2}
254
254
255
-
A `Promise` that resolves with the metadata for this object. If this object doesn't exist or metadata cannot be retreived, the promise is rejected.
255
+
A `Promise` that resolves with the metadata for this object. If this object doesn't exist or metadata cannot be retrieved, the promise is rejected.
0 commit comments