Skip to content

Update api reports and reference docs #4361

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

Merged
merged 4 commits into from
Mar 2, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
6 changes: 3 additions & 3 deletions common/api-review/app-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
```ts

import { Component } from '@firebase/component';
import { FirebaseApp } from '@firebase/app-types';
import { FirebaseAppConfig } from '@firebase/app-types';
import { FirebaseOptions } from '@firebase/app-types';
import { FirebaseApp } from '@firebase/app-types-exp';
import { FirebaseAppConfig } from '@firebase/app-types-exp';
import { FirebaseOptions } from '@firebase/app-types-exp';
import { LogCallback } from '@firebase/logger';
import { LogLevelString } from '@firebase/logger';
import { LogOptions } from '@firebase/logger';
Expand Down
4 changes: 3 additions & 1 deletion common/api-review/firestore-lite.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,9 @@ export class FirebaseFirestore implements FirestoreService {
protected _terminate(): Promise<void>;
// (undocumented)
get _terminated(): boolean;
}
// (undocumented)
toJSON(): object;
}

// @public
export interface FirestoreDataConverter<T> {
Expand Down
2 changes: 2 additions & 0 deletions common/api-review/firestore.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,6 +155,8 @@ export abstract class FieldValue {
export class FirebaseFirestore {
// (undocumented)
get app(): FirebaseApp;
// (undocumented)
toJSON(): object;
}

// @public
Expand Down
2 changes: 2 additions & 0 deletions common/api-review/firestore.lite.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,8 @@ export abstract class FieldValue {
// @public
export class FirebaseFirestore {
get app(): FirebaseApp;
// (undocumented)
toJSON(): object;
}

// @public
Expand Down
2 changes: 2 additions & 0 deletions common/api-review/installations-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ import { FirebaseInstallations } from '@firebase/installations-types-exp';
// @public
export function deleteInstallations(installations: FirebaseInstallations): Promise<void>;

export { FirebaseInstallations }

// @public
export function getId(installations: FirebaseInstallations): Promise<string>;

Expand Down
6 changes: 6 additions & 0 deletions common/api-review/performance-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,15 @@ import { FirebasePerformance } from '@firebase/performance-types-exp';
import { PerformanceSettings } from '@firebase/performance-types-exp';
import { PerformanceTrace } from '@firebase/performance-types-exp';

export { FirebasePerformance }

// @public
export function getPerformance(app: FirebaseApp, settings?: PerformanceSettings): FirebasePerformance;

export { PerformanceSettings }

export { PerformanceTrace }

// @public
export function trace(performance: FirebasePerformance, name: string): PerformanceTrace;

Expand Down
16 changes: 11 additions & 5 deletions common/api-review/remote-config-exp.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
```ts

import { FirebaseApp } from '@firebase/app-types-exp';
import { LogLevel } from '@firebase/remote-config-types-exp';
import { RemoteConfig } from '@firebase/remote-config-types-exp';
import { Value } from '@firebase/remote-config-types-exp';
import { LogLevel as RemoteConfigLogLevel } from '@firebase/remote-config-types-exp';
import { Value as ValueType } from '@firebase/remote-config-types-exp';

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

// @public
export function getAll(remoteConfig: RemoteConfig): Record<string, Value>;
export function getAll(remoteConfig: RemoteConfig): Record<string, ValueType>;

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

// @public
export function getValue(remoteConfig: RemoteConfig, key: string): Value;
export function getValue(remoteConfig: RemoteConfig, key: string): ValueType;

export { RemoteConfig }

export { RemoteConfigLogLevel }

// @public
export function setLogLevel(remoteConfig: RemoteConfig, logLevel: LogLevel): void;
export function setLogLevel(remoteConfig: RemoteConfig, logLevel: RemoteConfigLogLevel): void;

export { ValueType }


// (No @packageDocumentation comment for this package)
Expand Down
71 changes: 37 additions & 34 deletions common/api-review/storage-types.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,29 @@ export interface FirebaseStorageError extends FirebaseError {
serverResponse: string | null;
}

// @public
export interface FullMetadata extends UploadMetadata {
bucket: string;

downloadTokens: string[] | undefined;

fullPath: string;

generation: string;

metageneration: string;

name: string;

ref?: StorageReference | undefined;

size: number;

timeCreated: string;

updated: string;
}

// @public
export interface ListOptions {
maxResults?: number | null;
Expand All @@ -29,47 +52,22 @@ export interface ListResult {
}

// @public
export interface Metadata {
// (undocumented)
[prop: string]: unknown;

bucket: string;

cacheControl: string | undefined;
export interface SettableMetadata {
cacheControl?: string | undefined;

contentDisposition: string | undefined;
contentDisposition?: string | undefined;

contentEncoding: string | undefined;
contentEncoding?: string | undefined;

contentLanguage: string | undefined;
contentLanguage?: string | undefined;

contentType: string | undefined;
contentType?: string | undefined;

customMetadata:
customMetadata?:
| {
[key: string]: string;
}
| undefined;

downloadTokens: string[] | undefined;

fullPath: string;

generation: string;

md5Hash: string | undefined;

metageneration: string;

name: string;

ref: StorageReference | undefined;

size: number;

timeCreated: string;

updated: string;
}

// @public
Expand Down Expand Up @@ -106,9 +104,14 @@ export type TaskEvent = 'state_changed';
// @public
export type TaskState = 'running' | 'paused' | 'success' | 'canceled' | 'error';

// @public
export interface UploadMetadata extends SettableMetadata {
md5Hash?: string | undefined;
}

// @public
export interface UploadResult {
readonly metadata: Metadata;
readonly metadata: FullMetadata;

readonly ref: StorageReference;
}
Expand Down Expand Up @@ -139,7 +142,7 @@ export interface UploadTask {
export interface UploadTaskSnapshot {
bytesTransferred: number;

metadata: Metadata;
metadata: FullMetadata;

ref: StorageReference;

Expand Down
2 changes: 1 addition & 1 deletion common/api-review/storage.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

```ts

import { FirebaseApp } from '@firebase/app';
import { FirebaseApp } from '@firebase/app-types';
import { FirebaseStorageError } from '@firebase/storage-types/exp';
import { FullMetadata } from '@firebase/storage-types/exp';
import { ListOptions } from '@firebase/storage-types/exp';
Expand Down
2 changes: 0 additions & 2 deletions docs-exp/app-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,4 @@
| [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. |
| [FirebaseAppConfig](./app-types.firebaseappconfig.md) | |
| [FirebaseOptions](./app-types.firebaseoptions.md) | |
| [PlatformLoggerService](./app-types.platformloggerservice.md) | |
| [VersionService](./app-types.versionservice.md) | |

15 changes: 0 additions & 15 deletions docs-exp/app-types.platformloggerservice.getplatforminfostring.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs-exp/app-types.platformloggerservice.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs-exp/app-types.versionservice.library.md

This file was deleted.

19 changes: 0 additions & 19 deletions docs-exp/app-types.versionservice.md

This file was deleted.

11 changes: 0 additions & 11 deletions docs-exp/app-types.versionservice.version.md

This file was deleted.

6 changes: 6 additions & 0 deletions docs-exp/firestore_.firebasefirestore.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,9 @@ export declare class FirebaseFirestore
| --- | --- | --- | --- |
| [app](./firestore_.firebasefirestore.app.md) | | [FirebaseApp](./app-types.firebaseapp.md) | |

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [toJSON()](./firestore_.firebasefirestore.tojson.md) | | |

15 changes: 15 additions & 0 deletions docs-exp/firestore_.firebasefirestore.tojson.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@firebase/firestore](./firestore.md) &gt; [/](./firestore_.md) &gt; [FirebaseFirestore](./firestore_.firebasefirestore.md) &gt; [toJSON](./firestore_.firebasefirestore.tojson.md)

## FirebaseFirestore.toJSON() method

<b>Signature:</b>

```typescript
toJSON(): object;
```
<b>Returns:</b>

object

6 changes: 6 additions & 0 deletions docs-exp/firestore_lite.firebasefirestore.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,9 @@ export declare class FirebaseFirestore
| --- | --- | --- | --- |
| [app](./firestore_lite.firebasefirestore.app.md) | | [FirebaseApp](./app-types.firebaseapp.md) | The associated with this <code>Firestore</code> service instance. |

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [toJSON()](./firestore_lite.firebasefirestore.tojson.md) | | |

15 changes: 15 additions & 0 deletions docs-exp/firestore_lite.firebasefirestore.tojson.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[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)

## FirebaseFirestore.toJSON() method

<b>Signature:</b>

```typescript
toJSON(): object;
```
<b>Returns:</b>

object

1 change: 1 addition & 0 deletions docs-exp/performance-types.firebaseperformance.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

## FirebasePerformance interface


<b>Signature:</b>

```typescript
Expand Down
1 change: 1 addition & 0 deletions docs-exp/performance-types.performancetrace.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

## PerformanceTrace interface


<b>Signature:</b>

```typescript
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

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

## Metadata.bucket property
## FullMetadata.bucket property

The bucket this object is contained in.

Expand Down
Loading