Skip to content

Commit 5f508af

Browse files
committed
Update api reports and reference docs
1 parent 73bb561 commit 5f508af

File tree

55 files changed

+264
-218
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+264
-218
lines changed

common/api-review/app-exp.api.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
```ts
66

77
import { Component } from '@firebase/component';
8-
import { FirebaseApp } from '@firebase/app-types';
9-
import { FirebaseAppConfig } from '@firebase/app-types';
10-
import { FirebaseOptions } from '@firebase/app-types';
8+
import { FirebaseApp } from '@firebase/app-types-exp';
9+
import { FirebaseAppConfig } from '@firebase/app-types-exp';
10+
import { FirebaseOptions } from '@firebase/app-types-exp';
1111
import { LogCallback } from '@firebase/logger';
1212
import { LogLevelString } from '@firebase/logger';
1313
import { LogOptions } from '@firebase/logger';

common/api-review/firestore-lite.api.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,9 @@ export class FirebaseFirestore implements FirestoreService {
201201
protected _terminate(): Promise<void>;
202202
// (undocumented)
203203
get _terminated(): boolean;
204-
}
204+
// (undocumented)
205+
toJSON(): object;
206+
}
205207

206208
// @public
207209
export interface FirestoreDataConverter<T> {

common/api-review/firestore.api.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,8 @@ export abstract class FieldValue {
155155
export class FirebaseFirestore {
156156
// (undocumented)
157157
get app(): FirebaseApp;
158+
// (undocumented)
159+
toJSON(): object;
158160
}
159161

160162
// @public

common/api-review/firestore.lite.api.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,8 @@ export abstract class FieldValue {
122122
// @public
123123
export class FirebaseFirestore {
124124
get app(): FirebaseApp;
125+
// (undocumented)
126+
toJSON(): object;
125127
}
126128

127129
// @public

common/api-review/installations-exp.api.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ import { FirebaseInstallations } from '@firebase/installations-types-exp';
1010
// @public
1111
export function deleteInstallations(installations: FirebaseInstallations): Promise<void>;
1212

13+
export { FirebaseInstallations }
14+
1315
// @public
1416
export function getId(installations: FirebaseInstallations): Promise<string>;
1517

common/api-review/performance-exp.api.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,15 @@ import { FirebasePerformance } from '@firebase/performance-types-exp';
99
import { PerformanceSettings } from '@firebase/performance-types-exp';
1010
import { PerformanceTrace } from '@firebase/performance-types-exp';
1111

12+
export { FirebasePerformance }
13+
1214
// @public
1315
export function getPerformance(app: FirebaseApp, settings?: PerformanceSettings): FirebasePerformance;
1416

17+
export { PerformanceSettings }
18+
19+
export { PerformanceTrace }
20+
1521
// @public
1622
export function trace(performance: FirebasePerformance, name: string): PerformanceTrace;
1723

common/api-review/remote-config-exp.api.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55
```ts
66

77
import { FirebaseApp } from '@firebase/app-types-exp';
8-
import { LogLevel } from '@firebase/remote-config-types-exp';
98
import { RemoteConfig } from '@firebase/remote-config-types-exp';
10-
import { Value } from '@firebase/remote-config-types-exp';
9+
import { LogLevel as RemoteConfigLogLevel } from '@firebase/remote-config-types-exp';
10+
import { Value as ValueType } from '@firebase/remote-config-types-exp';
1111

1212
// @public
1313
export function activate(remoteConfig: RemoteConfig): Promise<boolean>;
@@ -22,7 +22,7 @@ export function fetchAndActivate(remoteConfig: RemoteConfig): Promise<boolean>;
2222
export function fetchConfig(remoteConfig: RemoteConfig): Promise<void>;
2323

2424
// @public
25-
export function getAll(remoteConfig: RemoteConfig): Record<string, Value>;
25+
export function getAll(remoteConfig: RemoteConfig): Record<string, ValueType>;
2626

2727
// @public
2828
export function getBoolean(remoteConfig: RemoteConfig, key: string): boolean;
@@ -37,10 +37,16 @@ export function getRemoteConfig(app: FirebaseApp): RemoteConfig;
3737
export function getString(remoteConfig: RemoteConfig, key: string): string;
3838

3939
// @public
40-
export function getValue(remoteConfig: RemoteConfig, key: string): Value;
40+
export function getValue(remoteConfig: RemoteConfig, key: string): ValueType;
41+
42+
export { RemoteConfig }
43+
44+
export { RemoteConfigLogLevel }
4145

4246
// @public
43-
export function setLogLevel(remoteConfig: RemoteConfig, logLevel: LogLevel): void;
47+
export function setLogLevel(remoteConfig: RemoteConfig, logLevel: RemoteConfigLogLevel): void;
48+
49+
export { ValueType }
4450

4551

4652
// (No @packageDocumentation comment for this package)

common/api-review/storage-types.api.md

Lines changed: 37 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,29 @@ export interface FirebaseStorageError extends FirebaseError {
1515
serverResponse: string | null;
1616
}
1717

18+
// @public
19+
export interface FullMetadata extends UploadMetadata {
20+
bucket: string;
21+
22+
downloadTokens: string[] | undefined;
23+
24+
fullPath: string;
25+
26+
generation: string;
27+
28+
metageneration: string;
29+
30+
name: string;
31+
32+
ref?: StorageReference | undefined;
33+
34+
size: number;
35+
36+
timeCreated: string;
37+
38+
updated: string;
39+
}
40+
1841
// @public
1942
export interface ListOptions {
2043
maxResults?: number | null;
@@ -29,47 +52,22 @@ export interface ListResult {
2952
}
3053

3154
// @public
32-
export interface Metadata {
33-
// (undocumented)
34-
[prop: string]: unknown;
35-
36-
bucket: string;
37-
38-
cacheControl: string | undefined;
55+
export interface SettableMetadata {
56+
cacheControl?: string | undefined;
3957

40-
contentDisposition: string | undefined;
58+
contentDisposition?: string | undefined;
4159

42-
contentEncoding: string | undefined;
60+
contentEncoding?: string | undefined;
4361

44-
contentLanguage: string | undefined;
62+
contentLanguage?: string | undefined;
4563

46-
contentType: string | undefined;
64+
contentType?: string | undefined;
4765

48-
customMetadata:
66+
customMetadata?:
4967
| {
5068
[key: string]: string;
5169
}
5270
| undefined;
53-
54-
downloadTokens: string[] | undefined;
55-
56-
fullPath: string;
57-
58-
generation: string;
59-
60-
md5Hash: string | undefined;
61-
62-
metageneration: string;
63-
64-
name: string;
65-
66-
ref: StorageReference | undefined;
67-
68-
size: number;
69-
70-
timeCreated: string;
71-
72-
updated: string;
7371
}
7472

7573
// @public
@@ -106,9 +104,14 @@ export type TaskEvent = 'state_changed';
106104
// @public
107105
export type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';
108106

107+
// @public
108+
export interface UploadMetadata extends SettableMetadata {
109+
md5Hash?: string | undefined;
110+
}
111+
109112
// @public
110113
export interface UploadResult {
111-
readonly metadata: Metadata;
114+
readonly metadata: FullMetadata;
112115

113116
readonly ref: StorageReference;
114117
}
@@ -139,7 +142,7 @@ export interface UploadTask {
139142
export interface UploadTaskSnapshot {
140143
bytesTransferred: number;
141144

142-
metadata: Metadata;
145+
metadata: FullMetadata;
143146

144147
ref: StorageReference;
145148

common/api-review/storage.api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
55
```ts
66

7-
import { FirebaseApp } from '@firebase/app';
7+
import { FirebaseApp } from '@firebase/app-types';
88
import { FirebaseStorageError } from '@firebase/storage-types/exp';
99
import { FullMetadata } from '@firebase/storage-types/exp';
1010
import { ListOptions } from '@firebase/storage-types/exp';

docs-exp/app-types.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,4 @@
1111
| [FirebaseApp](./app-types.firebaseapp.md) | A FirebaseApp holds the initialization information for a collection of services.<!-- -->Do not call this constructor directly. Instead, use [initializeApp()](./app.initializeapp.md) to create an app. |
1212
| [FirebaseAppConfig](./app-types.firebaseappconfig.md) | |
1313
| [FirebaseOptions](./app-types.firebaseoptions.md) | |
14-
| [PlatformLoggerService](./app-types.platformloggerservice.md) | |
15-
| [VersionService](./app-types.versionservice.md) | |
1614

docs-exp/app-types.platformloggerservice.getplatforminfostring.md

Lines changed: 0 additions & 15 deletions
This file was deleted.

docs-exp/app-types.platformloggerservice.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs-exp/app-types.versionservice.library.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs-exp/app-types.versionservice.md

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs-exp/app-types.versionservice.version.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs-exp/firestore_.firebasefirestore.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,9 @@ export declare class FirebaseFirestore
2020
| --- | --- | --- | --- |
2121
| [app](./firestore_.firebasefirestore.app.md) | | [FirebaseApp](./app-types.firebaseapp.md) | |
2222

23+
## Methods
24+
25+
| Method | Modifiers | Description |
26+
| --- | --- | --- |
27+
| [toJSON()](./firestore_.firebasefirestore.tojson.md) | | |
28+
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [/](./firestore_.md) &gt; [FirebaseFirestore](./firestore_.firebasefirestore.md) &gt; [toJSON](./firestore_.firebasefirestore.tojson.md)
4+
5+
## FirebaseFirestore.toJSON() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
toJSON(): object;
11+
```
12+
<b>Returns:</b>
13+
14+
object
15+

docs-exp/firestore_lite.firebasefirestore.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,9 @@ export declare class FirebaseFirestore
2020
| --- | --- | --- | --- |
2121
| [app](./firestore_lite.firebasefirestore.app.md) | | [FirebaseApp](./app-types.firebaseapp.md) | The associated with this <code>Firestore</code> service instance. |
2222

23+
## Methods
24+
25+
| Method | Modifiers | Description |
26+
| --- | --- | --- |
27+
| [toJSON()](./firestore_lite.firebasefirestore.tojson.md) | | |
28+
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [lite](./firestore_lite.md) &gt; [FirebaseFirestore](./firestore_lite.firebasefirestore.md) &gt; [toJSON](./firestore_lite.firebasefirestore.tojson.md)
4+
5+
## FirebaseFirestore.toJSON() method
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
toJSON(): object;
11+
```
12+
<b>Returns:</b>
13+
14+
object
15+

docs-exp/performance-types.firebaseperformance.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
## FirebasePerformance interface
66

7+
78
<b>Signature:</b>
89

910
```typescript

docs-exp/performance-types.performancetrace.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
## PerformanceTrace interface
66

7+
78
<b>Signature:</b>
89

910
```typescript

docs-exp/storage-types.metadata.bucket.md renamed to docs-exp/storage-types.fullmetadata.bucket.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
22

3-
[Home](./index.md) &gt; [@firebase/storage-types](./storage-types.md) &gt; [Metadata](./storage-types.metadata.md) &gt; [bucket](./storage-types.metadata.bucket.md)
3+
[Home](./index.md) &gt; [@firebase/storage-types](./storage-types.md) &gt; [FullMetadata](./storage-types.fullmetadata.md) &gt; [bucket](./storage-types.fullmetadata.bucket.md)
44

5-
## Metadata.bucket property
5+
## FullMetadata.bucket property
66

77
The bucket this object is contained in.
88

0 commit comments

Comments
 (0)