Skip to content

chore: Added package docs for module entry points #1275

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 1 commit into from
May 25, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 0 additions & 2 deletions etc/firebase-admin.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -457,6 +457,4 @@ export namespace storage {
}


// (No @packageDocumentation comment for this package)

```
2 changes: 0 additions & 2 deletions etc/firebase-admin.app.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,4 @@ export interface ServiceAccount {
}


// (No @packageDocumentation comment for this package)

```
2 changes: 0 additions & 2 deletions etc/firebase-admin.auth.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -454,6 +454,4 @@ export class UserRecord {
}


// (No @packageDocumentation comment for this package)

```
2 changes: 0 additions & 2 deletions etc/firebase-admin.database.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,4 @@ export const ServerValue: rtdb.ServerValue;
export { ThenableReference }


// (No @packageDocumentation comment for this package)

```
2 changes: 0 additions & 2 deletions etc/firebase-admin.firestore.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,4 @@ export { WriteBatch }
export { WriteResult }


// (No @packageDocumentation comment for this package)

```
2 changes: 0 additions & 2 deletions etc/firebase-admin.instance-id.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,4 @@ export class InstanceId {
}


// (No @packageDocumentation comment for this package)

```
2 changes: 0 additions & 2 deletions etc/firebase-admin.machine-learning.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,4 @@ export interface TFLiteModel {
}


// (No @packageDocumentation comment for this package)

```
2 changes: 0 additions & 2 deletions etc/firebase-admin.messaging.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -351,6 +351,4 @@ export interface WebpushNotification {
}


// (No @packageDocumentation comment for this package)

```
2 changes: 0 additions & 2 deletions etc/firebase-admin.project-management.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,4 @@ export class ShaCertificate {
}


// (No @packageDocumentation comment for this package)

```
2 changes: 0 additions & 2 deletions etc/firebase-admin.remote-config.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,4 @@ export interface Version {
}


// (No @packageDocumentation comment for this package)

```
2 changes: 0 additions & 2 deletions etc/firebase-admin.security-rules.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,4 @@ export class SecurityRules {
}


// (No @packageDocumentation comment for this package)

```
2 changes: 0 additions & 2 deletions etc/firebase-admin.storage.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,4 @@ export class Storage {
}


// (No @packageDocumentation comment for this package)

```
6 changes: 6 additions & 0 deletions src/app/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@

import { getSdkVersion } from '../utils';

/**
* Firebase App and SDK initialization.
*
* @packageDocumentation
*/

export { App, AppOptions, FirebaseArrayIndexError, FirebaseError } from './core'
export { initializeApp, getApp, getApps, deleteApp } from './lifecycle';

Expand Down
6 changes: 6 additions & 0 deletions src/auth/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@
* limitations under the License.
*/

/**
* Firebase Authentication.
*
* @packageDocumentation
*/

import { App, getApp } from '../app/index';
import { FirebaseApp } from '../app/firebase-app';
import { Auth } from './auth';
Expand Down
6 changes: 6 additions & 0 deletions src/database/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@
* limitations under the License.
*/

/**
* Firebase Realtime Database.
*
* @packageDocumentation
*/

import * as rtdb from '@firebase/database-types';
import {
enableLogging as enableLoggingFunc,
Expand Down
6 changes: 6 additions & 0 deletions src/default-namespace.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,10 @@
* limitations under the License.
*/

/**
* Firebase namespaced API (legacy).
*
* @packageDocumentation
*/

export * from './firebase-namespace-api';
6 changes: 6 additions & 0 deletions src/firestore/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@
* limitations under the License.
*/

/**
* Cloud Firestore.
*
* @packageDocumentation
*/

import { Firestore } from '@google-cloud/firestore';
import { App, getApp } from '../app';
import { FirebaseApp } from '../app/firebase-app';
Expand Down
8 changes: 7 additions & 1 deletion src/instance-id/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,15 @@
* limitations under the License.
*/

import { FirebaseApp } from '../app/firebase-app';
/**
* Firebase Instance ID service.
*
* @packageDocumentation
*/

import { App, getApp } from '../app/index';
import { InstanceId } from './instance-id';
import { FirebaseApp } from '../app/firebase-app';

export { InstanceId };

Expand Down
6 changes: 6 additions & 0 deletions src/machine-learning/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@
* limitations under the License.
*/

/**
* Firebase Machine Learning.
*
* @packageDocumentation
*/

import { App, getApp } from '../app';
import { FirebaseApp } from '../app/firebase-app';
import { MachineLearning } from './machine-learning';
Expand Down
6 changes: 6 additions & 0 deletions src/messaging/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@
* limitations under the License.
*/

/**
* Firebase Cloud Messaging (FCM).
*
* @packageDocumentation
*/

import { App, getApp } from '../app';
import { FirebaseApp } from '../app/firebase-app';
import { Messaging } from './messaging';
Expand Down
6 changes: 6 additions & 0 deletions src/project-management/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@
* limitations under the License.
*/

/**
* Firebase project management.
*
* @packageDocumentation
*/

import { App, getApp } from '../app';
import { FirebaseApp } from '../app/firebase-app';
import { ProjectManagement } from './project-management';
Expand Down
6 changes: 6 additions & 0 deletions src/remote-config/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@
* limitations under the License.
*/

/**
* Firebase Remote Config.
*
* @packageDocumentation
*/

import { App, getApp } from '../app';
import { FirebaseApp } from '../app/firebase-app';
import { RemoteConfig } from './remote-config';
Expand Down
6 changes: 6 additions & 0 deletions src/security-rules/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@
* limitations under the License.
*/

/**
* Security Rules for Cloud Firestore and Cloud Storage.
*
* @packageDocumentation
*/

import { App, getApp } from '../app';
import { FirebaseApp } from '../app/firebase-app';
import { SecurityRules } from './security-rules';
Expand Down
6 changes: 6 additions & 0 deletions src/storage/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@
* limitations under the License.
*/

/**
* Cloud Storage for Firebase.
*
* @packageDocumentation
*/

import { App, getApp } from '../app';
import { FirebaseApp } from '../app/firebase-app';
import { Storage } from './storage';
Expand Down