Skip to content

Commit 8142b28

Browse files
authored
[chore] Fixed links to rtdb api docs (#2501)
* Fixed links to rtdb api docs * fixed text to reference `database-compat`
1 parent e42840c commit 8142b28

File tree

4 files changed

+28
-28
lines changed

4 files changed

+28
-28
lines changed

docgen/extras/firebase-admin.database.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ The following externally defined APIs are re-exported from this module entry poi
44

55
| Symbol | Description |
66
| --- | --- |
7-
| [DataSnapshot](https://firebase.google.com/docs/reference/js/database.datasnapshot) | `DataSnapshot` type from the `@firebase/database` package. |
8-
| [EventType](https://firebase.google.com/docs/reference/js/database#eventtype) | `EventType` type from the `@firebase/database` package. |
9-
| [OnDisconnect](https://firebase.google.com/docs/reference/js/database.ondisconnect) | `OnDisconnect` type from the `@firebase/database` package. |
10-
| [Query](https://firebase.google.com/docs/reference/js/database.query) | `Query` type from the `@firebase/database` package. |
11-
| [DatabaseReference](https://firebase.google.com/docs/reference/js/database.databasereference) | `DatabaseReference` type from the `@firebase/database` package. |
12-
| [ThenableReference](https://firebase.google.com/docs/reference/js/database.thenablereference) | `ThenableReference` type from the `@firebase/database` package. |
7+
| [DataSnapshot](https://firebase.google.com/docs/reference/js/v8/firebase.database.DataSnapshot) | `DataSnapshot` type from the `@firebase/database-compat` package. |
8+
| [EventType](https://firebase.google.com/docs/reference/js/v8/firebase.database#eventtype) | `EventType` type from the `@firebase/database-compat` package. |
9+
| [OnDisconnect](https://firebase.google.com/docs/reference/js/v8/firebase.database.OnDisconnect) | `OnDisconnect` type from the `@firebase/database-compat` package. |
10+
| [Query](https://firebase.google.com/docs/reference/js/v8/firebase.database.Query) | `Query` type from the `@firebase/database-compat` package. |
11+
| [Reference](https://firebase.google.com/docs/reference/js/v8/firebase.database.Reference) | `Reference` type from the `@firebase/database-compat` package. |
12+
| [ThenableReference](https://firebase.google.com/docs/reference/js/v8/firebase.database.ThenableReference) | `ThenableReference` type from the `@firebase/database-compat` package. |

src/database/database-namespace.ts

+16-16
Original file line numberDiff line numberDiff line change
@@ -57,50 +57,50 @@ export namespace database {
5757
export type Database = TDatabase;
5858

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

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

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

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

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

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

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

101101
/**
102-
* {@link https://firebase.google.com/docs/reference/js/firebase.database.ServerValue | ServerValue}
103-
* constant from the `@firebase/database` package.
102+
* {@link https://firebase.google.com/docs/reference/js/v8/firebase.database.ServerValue | ServerValue}
103+
* constant from the `@firebase/database-compat` package.
104104
*/
105105
// eslint-disable-next-line @typescript-eslint/naming-convention
106106
export declare const ServerValue: rtdb.ServerValue;

src/database/database.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ import { getSdkVersion } from '../utils/index';
2929

3030
/**
3131
* The Firebase Database service interface. Extends the
32-
* {@link https://firebase.google.com/docs/reference/js/firebase.database.Database | Database}
33-
* interface provided by the `@firebase/database` package.
32+
* {@link https://firebase.google.com/docs/reference/js/v8/firebase.database.Database | Database}
33+
* interface provided by the `@firebase/database-compat` package.
3434
*/
3535
export interface Database extends FirebaseDatabase {
3636
/**

src/database/index.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,14 @@ export {
4343
// TODO: Remove the following any-cast once the typins in @firebase/database-types are fixed.
4444

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

5151
/**
52-
* {@link https://firebase.google.com/docs/reference/js/firebase.database.ServerValue | ServerValue}
53-
* constant from the `@firebase/database` package.
52+
* {@link https://firebase.google.com/docs/reference/js/v8/firebase.database.ServerValue | ServerValue}
53+
* constant from the `@firebase/database-compat` package.
5454
*/
5555
// eslint-disable-next-line @typescript-eslint/naming-convention
5656
export const ServerValue: rtdb.ServerValue = serverValueConst;

0 commit comments

Comments
 (0)