|
1 | | -## API Report File for "@firebase/firestore-lite" |
2 | | - |
3 | | -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). |
4 | | -
|
5 | | -```ts |
6 | | - |
7 | | -import { DocumentData as DocumentData_2 } from '@firebase/firestore-types'; |
8 | | -import { FirebaseApp } from '@firebase/app-types'; |
9 | | -import { FirebaseAuthInternalName } from '@firebase/auth-interop-types'; |
10 | | -import { _FirebaseService } from '@firebase/app-types'; |
11 | | -import { LogLevelString as LogLevel } from '@firebase/logger'; |
12 | | -import { Provider } from '@firebase/component'; |
13 | | -import { SetOptions as SetOptions_2 } from '@firebase/firestore-types'; |
14 | | - |
15 | | -// @public (undocumented) |
16 | | -export function addDoc<T>(reference: CollectionReference<T>, data: T): Promise<DocumentReference<T>>; |
17 | | - |
18 | | -// @public (undocumented) |
19 | | -export function arrayRemove(...elements: unknown[]): FieldValue; |
20 | | - |
21 | | -// @public (undocumented) |
22 | | -export function arrayUnion(...elements: unknown[]): FieldValue; |
23 | | - |
24 | | -// @public |
25 | | -export class Bytes { |
26 | | - constructor(byteString: ByteString); |
27 | | - // Warning: (ae-forgotten-export) The symbol "ByteString" needs to be exported by the entry point index.d.ts |
28 | | - // |
29 | | - // (undocumented) |
30 | | - _byteString: ByteString; |
31 | | - // (undocumented) |
32 | | - static fromBase64String(base64: string): Bytes; |
33 | | - // (undocumented) |
34 | | - static fromUint8Array(array: Uint8Array): Bytes; |
35 | | - // (undocumented) |
36 | | - isEqual(other: Bytes): boolean; |
37 | | - // (undocumented) |
38 | | - toBase64(): string; |
39 | | - // (undocumented) |
40 | | - toString(): string; |
41 | | - // (undocumented) |
42 | | - toUint8Array(): Uint8Array; |
43 | | -} |
44 | | - |
45 | | -// @public (undocumented) |
46 | | -export function collection(firestore: FirebaseFirestore, collectionPath: string): CollectionReference<DocumentData>; |
47 | | - |
48 | | -// @public (undocumented) |
49 | | -export function collection(reference: CollectionReference<unknown>, collectionPath: string): CollectionReference<DocumentData>; |
50 | | - |
51 | | -// @public (undocumented) |
52 | | -export function collection(reference: DocumentReference, collectionPath: string): CollectionReference<DocumentData>; |
53 | | - |
54 | | -// @public (undocumented) |
55 | | -export function collectionGroup(firestore: FirebaseFirestore, collectionId: string): Query<DocumentData>; |
56 | | - |
57 | | -// @public (undocumented) |
58 | | -export class CollectionReference<T = DocumentData> extends Query<T> { |
59 | | - constructor(firestore: FirebaseFirestore, converter: FirestoreDataConverter<T> | null, _path: ResourcePath); |
60 | | - // (undocumented) |
61 | | - doc(path?: string): DocumentReference<T>; |
62 | | - // (undocumented) |
63 | | - readonly firestore: FirebaseFirestore; |
64 | | - // (undocumented) |
65 | | - get id(): string; |
66 | | - // (undocumented) |
67 | | - get parent(): DocumentReference<DocumentData> | null; |
68 | | - // (undocumented) |
69 | | - get path(): string; |
70 | | - // Warning: (ae-forgotten-export) The symbol "ResourcePath" needs to be exported by the entry point index.d.ts |
71 | | - // |
72 | | - // (undocumented) |
73 | | - readonly _path: ResourcePath; |
74 | | - // (undocumented) |
75 | | - readonly type = "collection"; |
76 | | - // (undocumented) |
77 | | - withConverter<U>(converter: FirestoreDataConverter<U>): CollectionReference<U>; |
78 | | -} |
79 | | - |
80 | | -// @public (undocumented) |
81 | | -export function deleteDoc(reference: DocumentReference): Promise<void>; |
82 | | - |
83 | | -// @public (undocumented) |
84 | | -export function deleteField(): FieldValue; |
85 | | - |
86 | | -// @public (undocumented) |
87 | | -export function doc(firestore: FirebaseFirestore, documentPath: string): DocumentReference<DocumentData>; |
88 | | - |
89 | | -// @public (undocumented) |
90 | | -export function doc<T>(reference: CollectionReference<T>, documentPath?: string): DocumentReference<T>; |
91 | | - |
92 | | -// @public (undocumented) |
93 | | -export function doc(reference: DocumentReference<unknown>, documentPath: string): DocumentReference<DocumentData>; |
94 | | - |
95 | | -// @public (undocumented) |
96 | | -export interface DocumentData { |
97 | | - // (undocumented) |
98 | | - [field: string]: any; |
99 | | -} |
100 | | - |
101 | | -// @public (undocumented) |
102 | | -export function documentId(): FieldPath; |
103 | | - |
104 | | -// Warning: (ae-forgotten-export) The symbol "_DocumentKeyReference" needs to be exported by the entry point index.d.ts |
105 | | -// |
106 | | -// @public |
107 | | -export class DocumentReference<T = DocumentData> extends _DocumentKeyReference<T> { |
108 | | - constructor(firestore: FirebaseFirestore, converter: FirestoreDataConverter<T> | null, _path: ResourcePath); |
109 | | - // (undocumented) |
110 | | - collection(path: string): CollectionReference<DocumentData>; |
111 | | - // (undocumented) |
112 | | - readonly converter: FirestoreDataConverter<T> | null; |
113 | | - // (undocumented) |
114 | | - readonly firestore: FirebaseFirestore; |
115 | | - // (undocumented) |
116 | | - get id(): string; |
117 | | - // (undocumented) |
118 | | - get parent(): CollectionReference<T>; |
119 | | - // (undocumented) |
120 | | - get path(): string; |
121 | | - // (undocumented) |
122 | | - readonly _path: ResourcePath; |
123 | | - // (undocumented) |
124 | | - readonly type = "document"; |
125 | | - // (undocumented) |
126 | | - withConverter<U>(converter: FirestoreDataConverter<U>): DocumentReference<U>; |
127 | | -} |
128 | | - |
129 | | -// @public (undocumented) |
130 | | -export class DocumentSnapshot<T = DocumentData> { |
131 | | - constructor(_firestore: FirebaseFirestore, _key: DocumentKey, _document: Document_2 | null, _converter: UntypedFirestoreDataConverter<T> | null); |
132 | | - // Warning: (ae-forgotten-export) The symbol "UntypedFirestoreDataConverter" needs to be exported by the entry point index.d.ts |
133 | | - // |
134 | | - // (undocumented) |
135 | | - _converter: UntypedFirestoreDataConverter<T> | null; |
136 | | - // (undocumented) |
137 | | - data(): T | undefined; |
138 | | - // Warning: (ae-forgotten-export) The symbol "Document" needs to be exported by the entry point index.d.ts |
139 | | - // |
140 | | - // (undocumented) |
141 | | - _document: Document_2 | null; |
142 | | - // (undocumented) |
143 | | - exists(): this is QueryDocumentSnapshot<T>; |
144 | | - // (undocumented) |
145 | | - _firestore: FirebaseFirestore; |
146 | | - // (undocumented) |
147 | | - get(fieldPath: string | FieldPath): any; |
148 | | - // (undocumented) |
149 | | - get id(): string; |
150 | | - // Warning: (ae-forgotten-export) The symbol "DocumentKey" needs to be exported by the entry point index.d.ts |
151 | | - // |
152 | | - // (undocumented) |
153 | | - _key: DocumentKey; |
154 | | - // (undocumented) |
155 | | - get ref(): DocumentReference<T>; |
156 | | -} |
157 | | - |
158 | | -// @public (undocumented) |
159 | | -export function endAt(snapshot: DocumentSnapshot<unknown>): QueryConstraint; |
160 | | - |
161 | | -// @public (undocumented) |
162 | | -export function endAt(...fieldValues: unknown[]): QueryConstraint; |
163 | | - |
164 | | -// @public (undocumented) |
165 | | -export function endBefore(snapshot: DocumentSnapshot<unknown>): QueryConstraint; |
166 | | - |
167 | | -// @public (undocumented) |
168 | | -export function endBefore(...fieldValues: unknown[]): QueryConstraint; |
169 | | - |
170 | | -// Warning: (ae-forgotten-export) The symbol "_BaseFieldPath" needs to be exported by the entry point index.d.ts |
171 | | -// |
172 | | -// @public (undocumented) |
173 | | -export class B1 extends A1<string> { |
174 | | -} |
175 | | - |
176 | | - |
177 | | -// (No @packageDocumentation comment for this package) |
178 | | - |
179 | | -``` |
| 1 | +## API Report File for "@firebase/firestore-lite" |
| 2 | + |
| 3 | +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). |
| 4 | +
|
| 5 | +```ts |
| 6 | + |
| 7 | +// Warning: (ae-forgotten-export) The symbol "A1" needs to be exported by the entry point index.d.ts |
| 8 | +// |
| 9 | +// @public (undocumented) |
| 10 | +export class B1 extends A1<string> { |
| 11 | +} |
| 12 | + |
| 13 | + |
| 14 | +// (No @packageDocumentation comment for this package) |
| 15 | + |
| 16 | +``` |
0 commit comments