Skip to content

Commit a32ea8b

Browse files
committed
Updated docsite
1 parent 4bc9433 commit a32ea8b

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

common/api-review/storage.api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ import { Unsubscribe } from '@firebase/util';
1919
// @public
2020
export function connectStorageEmulator(storage: FirebaseStorage, host: string, port: number, options?: {
2121
mockUserToken?: EmulatorMockTokenOptions | string;
22+
ssl?: boolean;
2223
}): void;
2324

2425
// Warning: (ae-forgotten-export) The symbol "StringData" needs to be exported by the entry point index.d.ts

docs-devsite/storage.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Cloud Storage for Firebase
1919
| <b>function(app, ...)</b> |
2020
| [getStorage(app, bucketUrl)](./storage.md#getstorage_25f3a57) | Gets a [FirebaseStorage](./storage.firebasestorage.md#firebasestorage_interface) instance for the given Firebase app. |
2121
| <b>function(storage, ...)</b> |
22-
| [connectStorageEmulator(storage, host, port, options)](./storage.md#connectstorageemulator_e9039de) | Modify this [FirebaseStorage](./storage.firebasestorage.md#firebasestorage_interface) instance to communicate with the Cloud Storage emulator. |
22+
| [connectStorageEmulator(storage, host, port, options)](./storage.md#connectstorageemulator_ac343b7) | Modify this [FirebaseStorage](./storage.firebasestorage.md#firebasestorage_interface) instance to communicate with the Cloud Storage emulator. |
2323
| [ref(storage, url)](./storage.md#ref_5672fc1) | Returns a [StorageReference](./storage.storagereference.md#storagereference_interface) for the given url. |
2424
| <b>function(ref, ...)</b> |
2525
| [deleteObject(ref)](./storage.md#deleteobject_30df0b2) | Deletes the object at this location. |
@@ -106,7 +106,7 @@ A [FirebaseStorage](./storage.firebasestorage.md#firebasestorage_interface) inst
106106

107107
## function(storage, ...)
108108

109-
### connectStorageEmulator(storage, host, port, options) {:#connectstorageemulator_e9039de}
109+
### connectStorageEmulator(storage, host, port, options) {:#connectstorageemulator_ac343b7}
110110

111111
Modify this [FirebaseStorage](./storage.firebasestorage.md#firebasestorage_interface) instance to communicate with the Cloud Storage emulator.
112112

@@ -115,6 +115,7 @@ Modify this [FirebaseStorage](./storage.firebasestorage.md#firebasestorage_inter
115115
```typescript
116116
export declare function connectStorageEmulator(storage: FirebaseStorage, host: string, port: number, options?: {
117117
mockUserToken?: EmulatorMockTokenOptions | string;
118+
ssl?: boolean;
118119
}): void;
119120
```
120121

@@ -125,7 +126,7 @@ export declare function connectStorageEmulator(storage: FirebaseStorage, host: s
125126
| storage | [FirebaseStorage](./storage.firebasestorage.md#firebasestorage_interface) | The [FirebaseStorage](./storage.firebasestorage.md#firebasestorage_interface) instance |
126127
| host | string | The emulator host (ex: localhost) |
127128
| port | number | The emulator port (ex: 5001) |
128-
| options | { mockUserToken?: [EmulatorMockTokenOptions](./util.md#emulatormocktokenoptions) \| string; } | Emulator options. <code>options.mockUserToken</code> is the mock auth token to use for unit testing Security Rules. |
129+
| options | { mockUserToken?: [EmulatorMockTokenOptions](./util.md#emulatormocktokenoptions) \| string; ssl?: boolean; } | Emulator options. <code>options.mockUserToken</code> is the mock auth token to use for unit testing Security Rules. |
129130

130131
<b>Returns:</b>
131132

packages/storage-compat/src/service.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ export class StorageServiceCompat
9292
port: number,
9393
options: {
9494
mockUserToken?: EmulatorMockTokenOptions | string;
95+
ssl?: boolean
9596
} = {}
9697
): void {
9798
connectStorageEmulator(this._delegate, host, port, options);

0 commit comments

Comments
 (0)