Skip to content
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

[chore] Fixed links to rtdb api docs #2501

Merged
merged 3 commits into from
Mar 25, 2024
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
12 changes: 6 additions & 6 deletions docgen/extras/firebase-admin.database.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ The following externally defined APIs are re-exported from this module entry poi

| Symbol | Description |
| --- | --- |
| [DataSnapshot](https://firebase.google.com/docs/reference/js/database.datasnapshot) | `DataSnapshot` type from the `@firebase/database` package. |
| [EventType](https://firebase.google.com/docs/reference/js/database#eventtype) | `EventType` type from the `@firebase/database` package. |
| [OnDisconnect](https://firebase.google.com/docs/reference/js/database.ondisconnect) | `OnDisconnect` type from the `@firebase/database` package. |
| [Query](https://firebase.google.com/docs/reference/js/database.query) | `Query` type from the `@firebase/database` package. |
| [DatabaseReference](https://firebase.google.com/docs/reference/js/database.databasereference) | `DatabaseReference` type from the `@firebase/database` package. |
| [ThenableReference](https://firebase.google.com/docs/reference/js/database.thenablereference) | `ThenableReference` type from the `@firebase/database` package. |
| [DataSnapshot](https://firebase.google.com/docs/reference/js/v8/firebase.database.DataSnapshot) | `DataSnapshot` type from the `@firebase/database-compat` package. |
| [EventType](https://firebase.google.com/docs/reference/js/v8/firebase.database#eventtype) | `EventType` type from the `@firebase/database-compat` package. |
| [OnDisconnect](https://firebase.google.com/docs/reference/js/v8/firebase.database.OnDisconnect) | `OnDisconnect` type from the `@firebase/database-compat` package. |
| [Query](https://firebase.google.com/docs/reference/js/v8/firebase.database.Query) | `Query` type from the `@firebase/database-compat` package. |
| [Reference](https://firebase.google.com/docs/reference/js/v8/firebase.database.Reference) | `Reference` type from the `@firebase/database-compat` package. |
| [ThenableReference](https://firebase.google.com/docs/reference/js/v8/firebase.database.ThenableReference) | `ThenableReference` type from the `@firebase/database-compat` package. |
32 changes: 16 additions & 16 deletions src/database/database-namespace.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,50 +57,50 @@ export namespace database {
export type Database = TDatabase;

/**
* Type alias to {@link https://firebase.google.com/docs/reference/js/firebase.database.DataSnapshot | DataSnapshot}
* type from the `@firebase/database` package.
* Type alias to {@link https://firebase.google.com/docs/reference/js/v8/firebase.database.DataSnapshot | DataSnapshot}
* type from the `@firebase/database-compat` package.
*/
export type DataSnapshot = rtdb.DataSnapshot;

/**
* Type alias to the {@link https://firebase.google.com/docs/reference/js/firebase.database#eventtype | EventType}
* type from the `@firebase/database` package.
* Type alias to the {@link https://firebase.google.com/docs/reference/js/v8/firebase.database#eventtype | EventType}
* type from the `@firebase/database-compat` package.
*/
export type EventType = rtdb.EventType;

/**
* Type alias to {@link https://firebase.google.com/docs/reference/js/firebase.database.OnDisconnect | OnDisconnect}
* type from the `@firebase/database` package.
* Type alias to {@link https://firebase.google.com/docs/reference/js/v8/firebase.database.OnDisconnect | OnDisconnect}
* type from the `@firebase/database-compat` package.
*/
export type OnDisconnect = rtdb.OnDisconnect;

/**
* Type alias to {@link https://firebase.google.com/docs/reference/js/firebase.database.Query | Query}
* type from the `@firebase/database` package.
* Type alias to {@link https://firebase.google.com/docs/reference/js/v8/firebase.database.Query | Query}
* type from the `@firebase/database-compat` package.
*/
export type Query = rtdb.Query;

/**
* Type alias to {@link https://firebase.google.com/docs/reference/js/firebase.database.Reference | Reference}
* type from the `@firebase/database` package.
* Type alias to {@link https://firebase.google.com/docs/reference/js/v8/firebase.database.Reference | Reference}
* type from the `@firebase/database-compat` package.
*/
export type Reference = rtdb.Reference;

/**
* Type alias to {@link https://firebase.google.com/docs/reference/js/firebase.database.ThenableReference |
* ThenableReference} type from the `@firebase/database` package.
* Type alias to {@link https://firebase.google.com/docs/reference/js/v8/firebase.database.ThenableReference |
* ThenableReference} type from the `@firebase/database-compat` package.
*/
export type ThenableReference = rtdb.ThenableReference;

/**
* {@link https://firebase.google.com/docs/reference/js/firebase.database#enablelogging | enableLogging}
* function from the `@firebase/database` package.
* {@link https://firebase.google.com/docs/reference/js/v8/firebase.database#enablelogging | enableLogging}
* function from the `@firebase/database-compat` package.
*/
export declare const enableLogging: typeof rtdb.enableLogging;

/**
* {@link https://firebase.google.com/docs/reference/js/firebase.database.ServerValue | ServerValue}
* constant from the `@firebase/database` package.
* {@link https://firebase.google.com/docs/reference/js/v8/firebase.database.ServerValue | ServerValue}
* constant from the `@firebase/database-compat` package.
*/
// eslint-disable-next-line @typescript-eslint/naming-convention
export declare const ServerValue: rtdb.ServerValue;
Expand Down
4 changes: 2 additions & 2 deletions src/database/database.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ import { getSdkVersion } from '../utils/index';

/**
* The Firebase Database service interface. Extends the
* {@link https://firebase.google.com/docs/reference/js/firebase.database.Database | Database}
* interface provided by the `@firebase/database` package.
* {@link https://firebase.google.com/docs/reference/js/v8/firebase.database.Database | Database}
* interface provided by the `@firebase/database-compat` package.
*/
export interface Database extends FirebaseDatabase {
/**
Expand Down
8 changes: 4 additions & 4 deletions src/database/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,14 +43,14 @@ export {
// TODO: Remove the following any-cast once the typins in @firebase/database-types are fixed.

/**
* {@link https://firebase.google.com/docs/reference/js/firebase.database#enablelogging | enableLogging}
* function from the `@firebase/database` package.
* {@link https://firebase.google.com/docs/reference/js/v8/firebase.database#enablelogging | enableLogging}
* function from the `@firebase/database-compat` package.
*/
export const enableLogging: typeof rtdb.enableLogging = enableLoggingFunc as any;

/**
* {@link https://firebase.google.com/docs/reference/js/firebase.database.ServerValue | ServerValue}
* constant from the `@firebase/database` package.
* {@link https://firebase.google.com/docs/reference/js/v8/firebase.database.ServerValue | ServerValue}
* constant from the `@firebase/database-compat` package.
*/
// eslint-disable-next-line @typescript-eslint/naming-convention
export const ServerValue: rtdb.ServerValue = serverValueConst;
Expand Down
Loading