From e8903ae955995e8bf0df0f2812fdf808ccd6184b Mon Sep 17 00:00:00 2001 From: Feiyang1 Date: Thu, 8 Apr 2021 22:38:02 -0700 Subject: [PATCH 1/6] add package descriptions --- packages-exp/analytics-exp/src/index.ts | 6 ++++++ packages-exp/auth-exp/index.ts | 6 ++++++ packages-exp/functions-exp/src/index.ts | 6 ++++++ packages-exp/installations-exp/src/index.ts | 6 ++++++ packages-exp/messaging-exp/src/index.ts | 6 ++++++ packages-exp/performance-exp/src/index.ts | 6 ++++++ packages-exp/remote-config-exp/src/index.ts | 6 ++++++ packages/database/api-extractor.json | 2 +- packages/database/exp/index.ts | 6 ++++++ packages/firestore/exp/index.ts | 6 ++++++ packages/storage/exp/index.ts | 6 ++++++ scripts/exp/docgen.ts | 9 +++++++++ 12 files changed, 70 insertions(+), 1 deletion(-) diff --git a/packages-exp/analytics-exp/src/index.ts b/packages-exp/analytics-exp/src/index.ts index 34e91533ac4..0ec40773f81 100644 --- a/packages-exp/analytics-exp/src/index.ts +++ b/packages-exp/analytics-exp/src/index.ts @@ -1,3 +1,9 @@ +/** + * Firebase Analytics + * + * @packageDocumentation + */ + /** * @license * Copyright 2019 Google LLC diff --git a/packages-exp/auth-exp/index.ts b/packages-exp/auth-exp/index.ts index 2f985384abd..62f8204f643 100644 --- a/packages-exp/auth-exp/index.ts +++ b/packages-exp/auth-exp/index.ts @@ -1,3 +1,9 @@ +/** + * Firebase Authentication + * + * @packageDocumentation + */ + /** * @license * Copyright 2017 Google LLC diff --git a/packages-exp/functions-exp/src/index.ts b/packages-exp/functions-exp/src/index.ts index ad8b299b634..501de640c65 100644 --- a/packages-exp/functions-exp/src/index.ts +++ b/packages-exp/functions-exp/src/index.ts @@ -1,3 +1,9 @@ +/** + * Firebase Cloud Functions + * + * @packageDocumentation + */ + /** * @license * Copyright 2017 Google LLC diff --git a/packages-exp/installations-exp/src/index.ts b/packages-exp/installations-exp/src/index.ts index 671bd467083..5aa6674dea3 100644 --- a/packages-exp/installations-exp/src/index.ts +++ b/packages-exp/installations-exp/src/index.ts @@ -1,3 +1,9 @@ +/** + * Firebase Installations + * + * @packageDocumentation + */ + /** * @license * Copyright 2019 Google LLC diff --git a/packages-exp/messaging-exp/src/index.ts b/packages-exp/messaging-exp/src/index.ts index 5ed03c827d4..c82af63762b 100644 --- a/packages-exp/messaging-exp/src/index.ts +++ b/packages-exp/messaging-exp/src/index.ts @@ -1,3 +1,9 @@ +/** + * Firebase Cloud Messaging + * + * @packageDocumentation + */ + /** * @license * Copyright 2017 Google LLC diff --git a/packages-exp/performance-exp/src/index.ts b/packages-exp/performance-exp/src/index.ts index 8e951015e75..613cdf50767 100644 --- a/packages-exp/performance-exp/src/index.ts +++ b/packages-exp/performance-exp/src/index.ts @@ -1,3 +1,9 @@ +/** + * Firebase Performance Monitoring + * + * @packageDocumentation + */ + /** * @license * Copyright 2020 Google LLC diff --git a/packages-exp/remote-config-exp/src/index.ts b/packages-exp/remote-config-exp/src/index.ts index 665535c968c..b51873453fe 100644 --- a/packages-exp/remote-config-exp/src/index.ts +++ b/packages-exp/remote-config-exp/src/index.ts @@ -1,3 +1,9 @@ +/** + * Firebase Remote Config + * + * @packageDocumentation + */ + /** * @license * Copyright 2020 Google LLC diff --git a/packages/database/api-extractor.json b/packages/database/api-extractor.json index c2a260fb043..af5554eb1e4 100644 --- a/packages/database/api-extractor.json +++ b/packages/database/api-extractor.json @@ -1,5 +1,5 @@ { "extends": "../../config/api-extractor.json", // Point it to your entry point d.ts file. - "mainEntryPointFilePath": "/exp-types/index.d.ts" + "mainEntryPointFilePath": "/dist/exp/index.d.ts" } \ No newline at end of file diff --git a/packages/database/exp/index.ts b/packages/database/exp/index.ts index b2e7bc1894a..30c71177e81 100644 --- a/packages/database/exp/index.ts +++ b/packages/database/exp/index.ts @@ -1,3 +1,9 @@ +/** + * Firebase Realtime Database + * + * @packageDocumentation + */ + /** * @license * Copyright 2020 Google LLC diff --git a/packages/firestore/exp/index.ts b/packages/firestore/exp/index.ts index 768973e00f6..e208741858a 100644 --- a/packages/firestore/exp/index.ts +++ b/packages/firestore/exp/index.ts @@ -1,3 +1,9 @@ +/** + * Firebase Cloud Firestore + * + * @packageDocumentation + */ + /** * @license * Copyright 2020 Google LLC diff --git a/packages/storage/exp/index.ts b/packages/storage/exp/index.ts index c105d1644b7..cbea77da2f8 100644 --- a/packages/storage/exp/index.ts +++ b/packages/storage/exp/index.ts @@ -1,3 +1,9 @@ +/** + * Firebase Cloud Storage + * + * @packageDocumentation + */ + /** * @license * Copyright 2020 Google LLC diff --git a/scripts/exp/docgen.ts b/scripts/exp/docgen.ts index 88637ee070f..6fa9821fddc 100644 --- a/scripts/exp/docgen.ts +++ b/scripts/exp/docgen.ts @@ -53,6 +53,15 @@ async function generateDocs(forDevsite: boolean = false) { } ); + // build database-exp + await spawn( + 'yarn', + ['lerna', 'run', '--scope', '@firebase/database', 'build:exp'], + { + stdio: 'inherit' + } + ); + // generate public typings for firestore await spawn( 'yarn', From 527e322c9bc51b0f45875252ba9f5d654f8a989b Mon Sep 17 00:00:00 2001 From: Feiyang1 Date: Thu, 8 Apr 2021 22:46:00 -0700 Subject: [PATCH 2/6] initial capitals and periods --- packages-exp/remote-config-exp/src/api.ts | 44 +++++++++++----------- packages-exp/remote-config-exp/src/api2.ts | 2 +- 2 files changed, 23 insertions(+), 23 deletions(-) diff --git a/packages-exp/remote-config-exp/src/api.ts b/packages-exp/remote-config-exp/src/api.ts index 668f4c5b52b..be86cac9353 100644 --- a/packages-exp/remote-config-exp/src/api.ts +++ b/packages-exp/remote-config-exp/src/api.ts @@ -31,8 +31,8 @@ import { getModularInstance } from '@firebase/util'; /** * - * @param app - the firebase app instance - * @returns a remote config instance + * @param app - The firebase app instance. + * @returns A remote config instance. * * @public */ @@ -44,7 +44,7 @@ export function getRemoteConfig(app: FirebaseApp = getApp()): RemoteConfig { /** * Makes the last fetched config available to the getters. - * @param remoteConfig - the remote config instance + * @param remoteConfig - The remote config instance. * @returns A promise which resolves to true if the current call activated the fetched configs. * If the fetched configs were already activated, the promise will resolve to false. * @@ -75,9 +75,9 @@ export async function activate(remoteConfig: RemoteConfig): Promise { /** * Ensures the last activated config are available to the getters. - * @param remoteConfig - the remote config instance + * @param remoteConfig - The remote config instance. * - * @returns A promise that resolves when the last activated config is available to the getters + * @returns A promise that resolves when the last activated config is available to the getters. * @public */ export function ensureInitialized(remoteConfig: RemoteConfig): Promise { @@ -92,7 +92,7 @@ export function ensureInitialized(remoteConfig: RemoteConfig): Promise { /** * Fetches and caches configuration from the Remote Config service. - * @param remoteConfig - the remote config instance + * @param remoteConfig - The remote config instance. * @public */ export async function fetchConfig(remoteConfig: RemoteConfig): Promise { @@ -134,8 +134,8 @@ export async function fetchConfig(remoteConfig: RemoteConfig): Promise { /** * Gets all config. * - * @param remoteConfig - the remote config instance - * @returns all config + * @param remoteConfig - The remote config instance. + * @returns All config. * * @public */ @@ -155,10 +155,10 @@ export function getAll(remoteConfig: RemoteConfig): Record { * * Convenience method for calling remoteConfig.getValue(key).asBoolean(). * - * @param remoteConfig - the remote config instance - * @param key - the name of the parameter + * @param remoteConfig - The remote config instance. + * @param key - The name of the parameter. * - * @returns the value for the given key as a boolean + * @returns The value for the given key as a boolean. * @public */ export function getBoolean(remoteConfig: RemoteConfig, key: string): boolean { @@ -170,10 +170,10 @@ export function getBoolean(remoteConfig: RemoteConfig, key: string): boolean { * * Convenience method for calling remoteConfig.getValue(key).asNumber(). * - * @param remoteConfig - the remote config instance - * @param key - the name of the parameter + * @param remoteConfig - The remote config instance. + * @param key - The name of the parameter. * - * @returns the value for the given key as a number + * @returns The value for the given key as a number. * * @public */ @@ -185,10 +185,10 @@ export function getNumber(remoteConfig: RemoteConfig, key: string): number { * Gets the value for the given key as a String. * Convenience method for calling remoteConfig.getValue(key).asString(). * - * @param remoteConfig - the remote config instance - * @param key - the name of the parameter + * @param remoteConfig - The remote config instance. + * @param key - The name of the parameter. * - * @returns the value for the given key as a String + * @returns The value for the given key as a String. * * @public */ @@ -199,10 +199,10 @@ export function getString(remoteConfig: RemoteConfig, key: string): string { /** * Gets the {@link @firebase/remote-config-types#Value} for the given key. * - * @param remoteConfig - the remote config instance - * @param key - the name of the parameter + * @param remoteConfig - The remote config instance. + * @param key - The name of the parameter. * - * @returns the value for the given key + * @returns The value for the given key. * * @public */ @@ -230,8 +230,8 @@ export function getValue(remoteConfig: RemoteConfig, key: string): Value { /** * Defines the log level to use. * - * @param remoteConfig - the remote config instance - * @param logLevel - the log level to set + * @param remoteConfig - The remote config instance. + * @param logLevel - The log level to set. * * @public */ diff --git a/packages-exp/remote-config-exp/src/api2.ts b/packages-exp/remote-config-exp/src/api2.ts index 49065e038c3..7d0689a8561 100644 --- a/packages-exp/remote-config-exp/src/api2.ts +++ b/packages-exp/remote-config-exp/src/api2.ts @@ -25,7 +25,7 @@ import { getModularInstance } from '@firebase/util'; * * Performs fetch and activate operations, as a convenience. * - * @param remoteConfig - the remote config instance + * @param remoteConfig - The remote config instance. * * @returns A promise which resolves to true if the current call activated the fetched configs. * If the fetched configs were already activated, the promise will resolve to false. From 80a6457cd3ee00b533c14fb56702b1a34335cb29 Mon Sep 17 00:00:00 2001 From: Feiyang1 Date: Thu, 8 Apr 2021 22:58:55 -0700 Subject: [PATCH 3/6] add parameter description to installations --- packages-exp/installations-exp/src/api/delete-installations.ts | 1 + packages-exp/installations-exp/src/api/get-id.ts | 1 + packages-exp/installations-exp/src/api/get-installations.ts | 1 + packages-exp/installations-exp/src/api/get-token.ts | 2 ++ packages-exp/installations-exp/src/api/on-id-change.ts | 3 +++ 5 files changed, 8 insertions(+) diff --git a/packages-exp/installations-exp/src/api/delete-installations.ts b/packages-exp/installations-exp/src/api/delete-installations.ts index 6d4f8a007fd..3430219a93d 100644 --- a/packages-exp/installations-exp/src/api/delete-installations.ts +++ b/packages-exp/installations-exp/src/api/delete-installations.ts @@ -24,6 +24,7 @@ import { FirebaseInstallations } from '../interfaces/public-types'; /** * Deletes the Firebase Installation and all associated data. + * @param installations - The Installations instance * * @public */ diff --git a/packages-exp/installations-exp/src/api/get-id.ts b/packages-exp/installations-exp/src/api/get-id.ts index ed2f50f5a59..20ddecfc3d8 100644 --- a/packages-exp/installations-exp/src/api/get-id.ts +++ b/packages-exp/installations-exp/src/api/get-id.ts @@ -23,6 +23,7 @@ import { FirebaseInstallations } from '../interfaces/public-types'; /** * Creates a Firebase Installation if there isn't one for the app and * returns the Installation ID. + * @param installations - The Installations instance * * @public */ diff --git a/packages-exp/installations-exp/src/api/get-installations.ts b/packages-exp/installations-exp/src/api/get-installations.ts index b36ef6f3a94..8b2ab08ac2a 100644 --- a/packages-exp/installations-exp/src/api/get-installations.ts +++ b/packages-exp/installations-exp/src/api/get-installations.ts @@ -20,6 +20,7 @@ import { FirebaseInstallations } from '../interfaces/public-types'; /** * Returns an instance of FirebaseInstallations associated with the given FirebaseApp instance. + * @param app - The Firebase App. * * @public */ diff --git a/packages-exp/installations-exp/src/api/get-token.ts b/packages-exp/installations-exp/src/api/get-token.ts index 664d50513c5..acca3fb1413 100644 --- a/packages-exp/installations-exp/src/api/get-token.ts +++ b/packages-exp/installations-exp/src/api/get-token.ts @@ -25,6 +25,8 @@ import { FirebaseInstallations } from '../interfaces/public-types'; /** * Returns an Installation auth token, identifying the current Firebase Installation. + * @param installations - The Installations instance + * @param forceRefresh - Force refresh regardless of token expiration. * * @public */ diff --git a/packages-exp/installations-exp/src/api/on-id-change.ts b/packages-exp/installations-exp/src/api/on-id-change.ts index 420cfb22fa1..72e39b15c5d 100644 --- a/packages-exp/installations-exp/src/api/on-id-change.ts +++ b/packages-exp/installations-exp/src/api/on-id-change.ts @@ -35,6 +35,9 @@ export type IdChangeUnsubscribeFn = () => void; /** * Sets a new callback that will get called when Installation ID changes. * Returns an unsubscribe function that will remove the callback when called. + * @param installations - The Installations instance + * @param callback - The callback function which will be invoked when FID changes + * @returns A function that can be called to unsubscribe * * @public */ From 8077564ba7aaf9e3ba4303cb85cb0a76f9bae157 Mon Sep 17 00:00:00 2001 From: Feiyang1 Date: Thu, 8 Apr 2021 23:11:03 -0700 Subject: [PATCH 4/6] add interface descriptions for perf --- packages-exp/performance-exp/src/public_types.ts | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/packages-exp/performance-exp/src/public_types.ts b/packages-exp/performance-exp/src/public_types.ts index 20125ae6e28..190ffa99b38 100644 --- a/packages-exp/performance-exp/src/public_types.ts +++ b/packages-exp/performance-exp/src/public_types.ts @@ -16,6 +16,8 @@ */ /** + * Defines configuration options for the Performance Monitoring SDK + * * @public */ export interface PerformanceSettings { @@ -27,6 +29,8 @@ export interface PerformanceSettings { } /** + * The Firebase Performance Monitoring service interface. + * * @public */ export interface FirebasePerformance { @@ -42,6 +46,8 @@ export interface FirebasePerformance { } /** + * The interface representing a Trace + * * @public */ export interface PerformanceTrace { From 0f9c84fa6e572e16938e15458c5952fffae64584 Mon Sep 17 00:00:00 2001 From: Feiyang1 Date: Fri, 9 Apr 2021 10:47:08 -0700 Subject: [PATCH 5/6] address comments --- packages-exp/functions-exp/src/index.ts | 2 +- .../src/api/delete-installations.ts | 2 +- .../installations-exp/src/api/get-id.ts | 2 +- .../src/api/get-installations.ts | 2 +- .../installations-exp/src/api/get-token.ts | 2 +- .../installations-exp/src/api/on-id-change.ts | 6 ++--- .../performance-exp/src/public_types.ts | 4 +-- packages-exp/remote-config-exp/src/api.ts | 26 +++++++++---------- packages/firestore/exp/index.ts | 2 +- packages/storage/exp/index.ts | 2 +- 10 files changed, 25 insertions(+), 25 deletions(-) diff --git a/packages-exp/functions-exp/src/index.ts b/packages-exp/functions-exp/src/index.ts index 501de640c65..903974e84a2 100644 --- a/packages-exp/functions-exp/src/index.ts +++ b/packages-exp/functions-exp/src/index.ts @@ -1,5 +1,5 @@ /** - * Firebase Cloud Functions + * Cloud Functions for Firebase * * @packageDocumentation */ diff --git a/packages-exp/installations-exp/src/api/delete-installations.ts b/packages-exp/installations-exp/src/api/delete-installations.ts index 3430219a93d..ec9a491021e 100644 --- a/packages-exp/installations-exp/src/api/delete-installations.ts +++ b/packages-exp/installations-exp/src/api/delete-installations.ts @@ -24,7 +24,7 @@ import { FirebaseInstallations } from '../interfaces/public-types'; /** * Deletes the Firebase Installation and all associated data. - * @param installations - The Installations instance + * @param installations - The Installations instance. * * @public */ diff --git a/packages-exp/installations-exp/src/api/get-id.ts b/packages-exp/installations-exp/src/api/get-id.ts index 20ddecfc3d8..df1abd7f54f 100644 --- a/packages-exp/installations-exp/src/api/get-id.ts +++ b/packages-exp/installations-exp/src/api/get-id.ts @@ -23,7 +23,7 @@ import { FirebaseInstallations } from '../interfaces/public-types'; /** * Creates a Firebase Installation if there isn't one for the app and * returns the Installation ID. - * @param installations - The Installations instance + * @param installations - The Installations instance. * * @public */ diff --git a/packages-exp/installations-exp/src/api/get-installations.ts b/packages-exp/installations-exp/src/api/get-installations.ts index 8b2ab08ac2a..71c4b00da87 100644 --- a/packages-exp/installations-exp/src/api/get-installations.ts +++ b/packages-exp/installations-exp/src/api/get-installations.ts @@ -20,7 +20,7 @@ import { FirebaseInstallations } from '../interfaces/public-types'; /** * Returns an instance of FirebaseInstallations associated with the given FirebaseApp instance. - * @param app - The Firebase App. + * @param app - The FirebaseApp instance. * * @public */ diff --git a/packages-exp/installations-exp/src/api/get-token.ts b/packages-exp/installations-exp/src/api/get-token.ts index acca3fb1413..1b17cd1128c 100644 --- a/packages-exp/installations-exp/src/api/get-token.ts +++ b/packages-exp/installations-exp/src/api/get-token.ts @@ -25,7 +25,7 @@ import { FirebaseInstallations } from '../interfaces/public-types'; /** * Returns an Installation auth token, identifying the current Firebase Installation. - * @param installations - The Installations instance + * @param installations - The Installations instance. * @param forceRefresh - Force refresh regardless of token expiration. * * @public diff --git a/packages-exp/installations-exp/src/api/on-id-change.ts b/packages-exp/installations-exp/src/api/on-id-change.ts index 72e39b15c5d..612f4f1beb0 100644 --- a/packages-exp/installations-exp/src/api/on-id-change.ts +++ b/packages-exp/installations-exp/src/api/on-id-change.ts @@ -35,9 +35,9 @@ export type IdChangeUnsubscribeFn = () => void; /** * Sets a new callback that will get called when Installation ID changes. * Returns an unsubscribe function that will remove the callback when called. - * @param installations - The Installations instance - * @param callback - The callback function which will be invoked when FID changes - * @returns A function that can be called to unsubscribe + * @param installations - The Installations instance. + * @param callback - The callback function that is invoked when FID changes. + * @returns A function that can be called to unsubscribe. * * @public */ diff --git a/packages-exp/performance-exp/src/public_types.ts b/packages-exp/performance-exp/src/public_types.ts index 190ffa99b38..756fca2febf 100644 --- a/packages-exp/performance-exp/src/public_types.ts +++ b/packages-exp/performance-exp/src/public_types.ts @@ -16,7 +16,7 @@ */ /** - * Defines configuration options for the Performance Monitoring SDK + * Defines configuration options for the Performance Monitoring SDK. * * @public */ @@ -46,7 +46,7 @@ export interface FirebasePerformance { } /** - * The interface representing a Trace + * The interface representing a `Trace`. * * @public */ diff --git a/packages-exp/remote-config-exp/src/api.ts b/packages-exp/remote-config-exp/src/api.ts index be86cac9353..476dc80c884 100644 --- a/packages-exp/remote-config-exp/src/api.ts +++ b/packages-exp/remote-config-exp/src/api.ts @@ -31,8 +31,8 @@ import { getModularInstance } from '@firebase/util'; /** * - * @param app - The firebase app instance. - * @returns A remote config instance. + * @param app - The Firebase App instance. + * @returns A Remote Config instance. * * @public */ @@ -44,7 +44,7 @@ export function getRemoteConfig(app: FirebaseApp = getApp()): RemoteConfig { /** * Makes the last fetched config available to the getters. - * @param remoteConfig - The remote config instance. + * @param remoteConfig - The Remote Config instance. * @returns A promise which resolves to true if the current call activated the fetched configs. * If the fetched configs were already activated, the promise will resolve to false. * @@ -75,7 +75,7 @@ export async function activate(remoteConfig: RemoteConfig): Promise { /** * Ensures the last activated config are available to the getters. - * @param remoteConfig - The remote config instance. + * @param remoteConfig - The Remote Config instance. * * @returns A promise that resolves when the last activated config is available to the getters. * @public @@ -92,7 +92,7 @@ export function ensureInitialized(remoteConfig: RemoteConfig): Promise { /** * Fetches and caches configuration from the Remote Config service. - * @param remoteConfig - The remote config instance. + * @param remoteConfig - The Remote Config instance. * @public */ export async function fetchConfig(remoteConfig: RemoteConfig): Promise { @@ -134,7 +134,7 @@ export async function fetchConfig(remoteConfig: RemoteConfig): Promise { /** * Gets all config. * - * @param remoteConfig - The remote config instance. + * @param remoteConfig - The Remote Config instance. * @returns All config. * * @public @@ -155,7 +155,7 @@ export function getAll(remoteConfig: RemoteConfig): Record { * * Convenience method for calling remoteConfig.getValue(key).asBoolean(). * - * @param remoteConfig - The remote config instance. + * @param remoteConfig - The Remote Config instance. * @param key - The name of the parameter. * * @returns The value for the given key as a boolean. @@ -170,7 +170,7 @@ export function getBoolean(remoteConfig: RemoteConfig, key: string): boolean { * * Convenience method for calling remoteConfig.getValue(key).asNumber(). * - * @param remoteConfig - The remote config instance. + * @param remoteConfig - The Remote Config instance. * @param key - The name of the parameter. * * @returns The value for the given key as a number. @@ -182,13 +182,13 @@ export function getNumber(remoteConfig: RemoteConfig, key: string): number { } /** - * Gets the value for the given key as a String. + * Gets the value for the given key as a string. * Convenience method for calling remoteConfig.getValue(key).asString(). * - * @param remoteConfig - The remote config instance. + * @param remoteConfig - The Remote Config instance. * @param key - The name of the parameter. * - * @returns The value for the given key as a String. + * @returns The value for the given key as a string. * * @public */ @@ -199,7 +199,7 @@ export function getString(remoteConfig: RemoteConfig, key: string): string { /** * Gets the {@link @firebase/remote-config-types#Value} for the given key. * - * @param remoteConfig - The remote config instance. + * @param remoteConfig - The Remote Config instance. * @param key - The name of the parameter. * * @returns The value for the given key. @@ -230,7 +230,7 @@ export function getValue(remoteConfig: RemoteConfig, key: string): Value { /** * Defines the log level to use. * - * @param remoteConfig - The remote config instance. + * @param remoteConfig - The Remote Config instance. * @param logLevel - The log level to set. * * @public diff --git a/packages/firestore/exp/index.ts b/packages/firestore/exp/index.ts index e208741858a..aab859b67a7 100644 --- a/packages/firestore/exp/index.ts +++ b/packages/firestore/exp/index.ts @@ -1,5 +1,5 @@ /** - * Firebase Cloud Firestore + * Cloud Firestore * * @packageDocumentation */ diff --git a/packages/storage/exp/index.ts b/packages/storage/exp/index.ts index cbea77da2f8..c3027536c5d 100644 --- a/packages/storage/exp/index.ts +++ b/packages/storage/exp/index.ts @@ -1,5 +1,5 @@ /** - * Firebase Cloud Storage + * Cloud Storage for Firebase * * @packageDocumentation */ From 6f84af3dcb1a3526d439e877a91dc4333833d927 Mon Sep 17 00:00:00 2001 From: Feiyang1 Date: Fri, 9 Apr 2021 10:58:05 -0700 Subject: [PATCH 6/6] address comments2 --- .../src/api/delete-installations.ts | 2 +- .../installations-exp/src/api/get-id.ts | 2 +- .../src/api/get-installations.ts | 2 +- .../installations-exp/src/api/get-token.ts | 2 +- .../installations-exp/src/api/on-id-change.ts | 2 +- packages-exp/performance-exp/src/index.ts | 10 ++++----- packages-exp/remote-config-exp/src/api.ts | 22 +++++++++---------- 7 files changed, 21 insertions(+), 21 deletions(-) diff --git a/packages-exp/installations-exp/src/api/delete-installations.ts b/packages-exp/installations-exp/src/api/delete-installations.ts index ec9a491021e..e41163939b1 100644 --- a/packages-exp/installations-exp/src/api/delete-installations.ts +++ b/packages-exp/installations-exp/src/api/delete-installations.ts @@ -24,7 +24,7 @@ import { FirebaseInstallations } from '../interfaces/public-types'; /** * Deletes the Firebase Installation and all associated data. - * @param installations - The Installations instance. + * @param installations - The `Installations` instance. * * @public */ diff --git a/packages-exp/installations-exp/src/api/get-id.ts b/packages-exp/installations-exp/src/api/get-id.ts index df1abd7f54f..cc3550fa1c5 100644 --- a/packages-exp/installations-exp/src/api/get-id.ts +++ b/packages-exp/installations-exp/src/api/get-id.ts @@ -23,7 +23,7 @@ import { FirebaseInstallations } from '../interfaces/public-types'; /** * Creates a Firebase Installation if there isn't one for the app and * returns the Installation ID. - * @param installations - The Installations instance. + * @param installations - The `Installations` instance. * * @public */ diff --git a/packages-exp/installations-exp/src/api/get-installations.ts b/packages-exp/installations-exp/src/api/get-installations.ts index 71c4b00da87..529bea79ecf 100644 --- a/packages-exp/installations-exp/src/api/get-installations.ts +++ b/packages-exp/installations-exp/src/api/get-installations.ts @@ -20,7 +20,7 @@ import { FirebaseInstallations } from '../interfaces/public-types'; /** * Returns an instance of FirebaseInstallations associated with the given FirebaseApp instance. - * @param app - The FirebaseApp instance. + * @param app - The `FirebaseApp` instance. * * @public */ diff --git a/packages-exp/installations-exp/src/api/get-token.ts b/packages-exp/installations-exp/src/api/get-token.ts index 1b17cd1128c..248ab68c7ec 100644 --- a/packages-exp/installations-exp/src/api/get-token.ts +++ b/packages-exp/installations-exp/src/api/get-token.ts @@ -25,7 +25,7 @@ import { FirebaseInstallations } from '../interfaces/public-types'; /** * Returns an Installation auth token, identifying the current Firebase Installation. - * @param installations - The Installations instance. + * @param installations - The `Installations` instance. * @param forceRefresh - Force refresh regardless of token expiration. * * @public diff --git a/packages-exp/installations-exp/src/api/on-id-change.ts b/packages-exp/installations-exp/src/api/on-id-change.ts index 612f4f1beb0..4d0750f61b1 100644 --- a/packages-exp/installations-exp/src/api/on-id-change.ts +++ b/packages-exp/installations-exp/src/api/on-id-change.ts @@ -35,7 +35,7 @@ export type IdChangeUnsubscribeFn = () => void; /** * Sets a new callback that will get called when Installation ID changes. * Returns an unsubscribe function that will remove the callback when called. - * @param installations - The Installations instance. + * @param installations - The `Installations` instance. * @param callback - The callback function that is invoked when FID changes. * @returns A function that can be called to unsubscribe. * diff --git a/packages-exp/performance-exp/src/index.ts b/packages-exp/performance-exp/src/index.ts index 613cdf50767..07d00b70dac 100644 --- a/packages-exp/performance-exp/src/index.ts +++ b/packages-exp/performance-exp/src/index.ts @@ -51,7 +51,7 @@ const DEFAULT_ENTRY_NAME = '[DEFAULT]'; /** * Returns a FirebasePerformance instance for the given app. - * @param app - The FirebaseApp to use. + * @param app - The `FirebaseApp` to use. * @public */ export function getPerformance( @@ -65,8 +65,8 @@ export function getPerformance( /** * Returns a FirebasePerformance instance for the given app. Can only be called once. - * @param app - The FirebaseApp to use. - * @param settings - Optional settings for the Performance instance. + * @param app - The `FirebaseApp` to use. + * @param settings - Optional settings for the `FirebasePerformance` instance. * @public */ export function initializePerformance( @@ -89,8 +89,8 @@ export function initializePerformance( } /** - * Returns a new PerformanceTrace instance. - * @param performance - The FirebasePerformance instance to use. + * Returns a new `PerformanceTrace` instance. + * @param performance - The `FirebasePerformance` instance to use. * @param name - The name of the trace. * @public */ diff --git a/packages-exp/remote-config-exp/src/api.ts b/packages-exp/remote-config-exp/src/api.ts index 476dc80c884..d6bd2f797ed 100644 --- a/packages-exp/remote-config-exp/src/api.ts +++ b/packages-exp/remote-config-exp/src/api.ts @@ -31,8 +31,8 @@ import { getModularInstance } from '@firebase/util'; /** * - * @param app - The Firebase App instance. - * @returns A Remote Config instance. + * @param app - The `FirebaseApp` instance. + * @returns A `RemoteConfig` instance. * * @public */ @@ -44,7 +44,7 @@ export function getRemoteConfig(app: FirebaseApp = getApp()): RemoteConfig { /** * Makes the last fetched config available to the getters. - * @param remoteConfig - The Remote Config instance. + * @param remoteConfig - The `RemoteConfig` instance. * @returns A promise which resolves to true if the current call activated the fetched configs. * If the fetched configs were already activated, the promise will resolve to false. * @@ -75,7 +75,7 @@ export async function activate(remoteConfig: RemoteConfig): Promise { /** * Ensures the last activated config are available to the getters. - * @param remoteConfig - The Remote Config instance. + * @param remoteConfig - The `RemoteConfig` instance. * * @returns A promise that resolves when the last activated config is available to the getters. * @public @@ -92,7 +92,7 @@ export function ensureInitialized(remoteConfig: RemoteConfig): Promise { /** * Fetches and caches configuration from the Remote Config service. - * @param remoteConfig - The Remote Config instance. + * @param remoteConfig - The `RemoteConfig` instance. * @public */ export async function fetchConfig(remoteConfig: RemoteConfig): Promise { @@ -134,7 +134,7 @@ export async function fetchConfig(remoteConfig: RemoteConfig): Promise { /** * Gets all config. * - * @param remoteConfig - The Remote Config instance. + * @param remoteConfig - The `RemoteConfig` instance. * @returns All config. * * @public @@ -155,7 +155,7 @@ export function getAll(remoteConfig: RemoteConfig): Record { * * Convenience method for calling remoteConfig.getValue(key).asBoolean(). * - * @param remoteConfig - The Remote Config instance. + * @param remoteConfig - The `RemoteConfig` instance. * @param key - The name of the parameter. * * @returns The value for the given key as a boolean. @@ -170,7 +170,7 @@ export function getBoolean(remoteConfig: RemoteConfig, key: string): boolean { * * Convenience method for calling remoteConfig.getValue(key).asNumber(). * - * @param remoteConfig - The Remote Config instance. + * @param remoteConfig - The `RemoteConfig` instance. * @param key - The name of the parameter. * * @returns The value for the given key as a number. @@ -185,7 +185,7 @@ export function getNumber(remoteConfig: RemoteConfig, key: string): number { * Gets the value for the given key as a string. * Convenience method for calling remoteConfig.getValue(key).asString(). * - * @param remoteConfig - The Remote Config instance. + * @param remoteConfig - The `RemoteConfig` instance. * @param key - The name of the parameter. * * @returns The value for the given key as a string. @@ -199,7 +199,7 @@ export function getString(remoteConfig: RemoteConfig, key: string): string { /** * Gets the {@link @firebase/remote-config-types#Value} for the given key. * - * @param remoteConfig - The Remote Config instance. + * @param remoteConfig - The `RemoteConfig` instance. * @param key - The name of the parameter. * * @returns The value for the given key. @@ -230,7 +230,7 @@ export function getValue(remoteConfig: RemoteConfig, key: string): Value { /** * Defines the log level to use. * - * @param remoteConfig - The Remote Config instance. + * @param remoteConfig - The `RemoteConfig` instance. * @param logLevel - The log level to set. * * @public