Skip to content

Commit ec08bfc

Browse files
hiranya911hiranya911
authored
chore: Added docstrings to type aliases in namespaces (#1247)
* chore: Adding documentation for type aliases * chore: Adding more type alias doc strings * chore: Added documentation to type aliases
1 parent 02e2ea2 commit ec08bfc

17 files changed

+557
-271
lines changed

‎etc/firebase-admin.api.md

Lines changed: 1 addition & 252 deletions
Large diffs are not rendered by default.

‎etc/firebase-admin.database.api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import { Reference } from '@firebase/database-types';
1414
import * as rtdb from '@firebase/database-types';
1515
import { ThenableReference } from '@firebase/database-types';
1616

17-
// @public (undocumented)
17+
// @public
1818
export interface Database extends FirebaseDatabase {
1919
getRules(): Promise<string>;
2020
getRulesJSON(): Promise<object>;

‎etc/firebase-admin.firestore.api.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ import { DocumentSnapshot } from '@google-cloud/firestore';
1616
import { FieldPath } from '@google-cloud/firestore';
1717
import { FieldValue } from '@google-cloud/firestore';
1818
import { Firestore } from '@google-cloud/firestore';
19-
import * as _firestore from '@google-cloud/firestore';
2019
import { FirestoreDataConverter } from '@google-cloud/firestore';
2120
import { GeoPoint } from '@google-cloud/firestore';
2221
import { GrpcStatus } from '@google-cloud/firestore';
@@ -64,7 +63,7 @@ export { GeoPoint }
6463
// Warning: (ae-forgotten-export) The symbol "App" needs to be exported by the entry point index.d.ts
6564
//
6665
// @public (undocumented)
67-
export function getFirestore(app?: App): _firestore.Firestore;
66+
export function getFirestore(app?: App): Firestore;
6867

6968
export { GrpcStatus }
7069

‎package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -57,17 +57,39 @@
5757
"types": "./lib/index.d.ts",
5858
"typesVersions": {
5959
"*": {
60-
"app": ["lib/app"],
61-
"auth": ["lib/auth"],
62-
"database": ["lib/database"],
63-
"firestore": ["lib/firestore"],
64-
"instance-id": ["lib/instance-id"],
65-
"machine-learning": ["lib/machine-learning"],
66-
"messaging": ["lib/messaging"],
67-
"project-management": ["lib/project-management"],
68-
"remote-config": ["lib/remote-config"],
69-
"security-rules": ["lib/security-rules"],
70-
"storage": ["lib/storage"]
60+
"app": [
61+
"lib/app"
62+
],
63+
"auth": [
64+
"lib/auth"
65+
],
66+
"database": [
67+
"lib/database"
68+
],
69+
"firestore": [
70+
"lib/firestore"
71+
],
72+
"instance-id": [
73+
"lib/instance-id"
74+
],
75+
"machine-learning": [
76+
"lib/machine-learning"
77+
],
78+
"messaging": [
79+
"lib/messaging"
80+
],
81+
"project-management": [
82+
"lib/project-management"
83+
],
84+
"remote-config": [
85+
"lib/remote-config"
86+
],
87+
"security-rules": [
88+
"lib/security-rules"
89+
],
90+
"storage": [
91+
"lib/storage"
92+
]
7193
}
7294
},
7395
"exports": {

‎src/auth/auth-namespace.ts

Lines changed: 203 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,55 +118,258 @@ export declare function auth(app?: App): auth.Auth;
118118

119119
/* eslint-disable @typescript-eslint/no-namespace */
120120
export namespace auth {
121+
/**
122+
* Type alias to {@link firebase-admin.auth#ActionCodeSettings}.
123+
*/
121124
export type ActionCodeSettings = TActionCodeSettings;
125+
126+
/**
127+
* Type alias to {@link firebase-admin.auth#Auth}.
128+
*/
122129
export type Auth = TAuth;
130+
131+
/**
132+
* Type alias to {@link firebase-admin.auth#AuthFactorType}.
133+
*/
123134
export type AuthFactorType = TAuthFactorType;
135+
136+
/**
137+
* Type alias to {@link firebase-admin.auth#AuthProviderConfig}.
138+
*/
124139
export type AuthProviderConfig = TAuthProviderConfig;
140+
141+
/**
142+
* Type alias to {@link firebase-admin.auth#AuthProviderConfigFilter}.
143+
*/
125144
export type AuthProviderConfigFilter = TAuthProviderConfigFilter;
145+
146+
/**
147+
* Type alias to {@link firebase-admin.auth#BaseAuth}.
148+
*/
126149
export type BaseAuth = TBaseAuth;
150+
151+
/**
152+
* Type alias to {@link firebase-admin.auth#CreateMultiFactorInfoRequest}.
153+
*/
127154
export type CreateMultiFactorInfoRequest = TCreateMultiFactorInfoRequest;
155+
156+
/**
157+
* Type alias to {@link firebase-admin.auth#CreatePhoneMultiFactorInfoRequest}.
158+
*/
128159
export type CreatePhoneMultiFactorInfoRequest = TCreatePhoneMultiFactorInfoRequest;
160+
161+
/**
162+
* Type alias to {@link firebase-admin.auth#CreateRequest}.
163+
*/
129164
export type CreateRequest = TCreateRequest;
165+
166+
/**
167+
* Type alias to {@link firebase-admin.auth#CreateTenantRequest}.
168+
*/
130169
export type CreateTenantRequest = TCreateTenantRequest;
170+
171+
/**
172+
* Type alias to {@link firebase-admin.auth#DecodedIdToken}.
173+
*/
131174
export type DecodedIdToken = TDecodedIdToken;
175+
176+
/**
177+
* Type alias to {@link firebase-admin.auth#DeleteUsersResult}.
178+
*/
132179
export type DeleteUsersResult = TDeleteUsersResult;
180+
181+
/**
182+
* Type alias to {@link firebase-admin.auth#EmailIdentifier}.
183+
*/
133184
export type EmailIdentifier = TEmailIdentifier;
185+
186+
/**
187+
* Type alias to {@link firebase-admin.auth#EmailSignInProviderConfig}.
188+
*/
134189
export type EmailSignInProviderConfig = TEmailSignInProviderConfig;
190+
191+
/**
192+
* Type alias to {@link firebase-admin.auth#GetUsersResult}.
193+
*/
135194
export type GetUsersResult = TGetUsersResult;
195+
196+
/**
197+
* Type alias to {@link firebase-admin.auth#HashAlgorithmType}.
198+
*/
136199
export type HashAlgorithmType = THashAlgorithmType;
200+
201+
/**
202+
* Type alias to {@link firebase-admin.auth#ListProviderConfigResults}.
203+
*/
137204
export type ListProviderConfigResults = TListProviderConfigResults;
205+
206+
/**
207+
* Type alias to {@link firebase-admin.auth#ListTenantsResult}.
208+
*/
138209
export type ListTenantsResult = TListTenantsResult;
210+
211+
/**
212+
* Type alias to {@link firebase-admin.auth#ListUsersResult}.
213+
*/
139214
export type ListUsersResult = TListUsersResult;
215+
216+
/**
217+
* Type alias to {@link firebase-admin.auth#MultiFactorCreateSettings}.
218+
*/
140219
export type MultiFactorCreateSettings = TMultiFactorCreateSettings;
220+
221+
/**
222+
* Type alias to {@link firebase-admin.auth#MultiFactorConfig}.
223+
*/
141224
export type MultiFactorConfig = TMultiFactorConfig;
225+
226+
/**
227+
* Type alias to {@link firebase-admin.auth#MultiFactorConfigState}.
228+
*/
142229
export type MultiFactorConfigState = TMultiFactorConfigState;
230+
231+
/**
232+
* Type alias to {@link firebase-admin.auth#MultiFactorInfo}.
233+
*/
143234
export type MultiFactorInfo = TMultiFactorInfo;
235+
236+
/**
237+
* Type alias to {@link firebase-admin.auth#MultiFactorUpdateSettings}.
238+
*/
144239
export type MultiFactorUpdateSettings = TMultiFactorUpdateSettings;
240+
241+
/**
242+
* Type alias to {@link firebase-admin.auth#MultiFactorSettings}.
243+
*/
145244
export type MultiFactorSettings = TMultiFactorSettings;
245+
246+
/**
247+
* Type alias to {@link firebase-admin.auth#OIDCAuthProviderConfig}.
248+
*/
146249
export type OIDCAuthProviderConfig = TOIDCAuthProviderConfig;
250+
251+
/**
252+
* Type alias to {@link firebase-admin.auth#OIDCUpdateAuthProviderRequest}.
253+
*/
147254
export type OIDCUpdateAuthProviderRequest = TOIDCUpdateAuthProviderRequest;
255+
256+
/**
257+
* Type alias to {@link firebase-admin.auth#PhoneIdentifier}.
258+
*/
148259
export type PhoneIdentifier = TPhoneIdentifier;
260+
261+
/**
262+
* Type alias to {@link firebase-admin.auth#PhoneMultiFactorInfo}.
263+
*/
149264
export type PhoneMultiFactorInfo = TPhoneMultiFactorInfo;
265+
266+
/**
267+
* Type alias to {@link firebase-admin.auth#ProviderIdentifier}.
268+
*/
150269
export type ProviderIdentifier = TProviderIdentifier;
270+
271+
/**
272+
* Type alias to {@link firebase-admin.auth#SAMLAuthProviderConfig}.
273+
*/
151274
export type SAMLAuthProviderConfig = TSAMLAuthProviderConfig;
275+
276+
/**
277+
* Type alias to {@link firebase-admin.auth#SAMLUpdateAuthProviderRequest}.
278+
*/
152279
export type SAMLUpdateAuthProviderRequest = TSAMLUpdateAuthProviderRequest;
280+
281+
/**
282+
* Type alias to {@link firebase-admin.auth#SessionCookieOptions}.
283+
*/
153284
export type SessionCookieOptions = TSessionCookieOptions;
285+
286+
/**
287+
* Type alias to {@link firebase-admin.auth#Tenant}.
288+
*/
154289
export type Tenant = TTenant;
290+
291+
/**
292+
* Type alias to {@link firebase-admin.auth#TenantAwareAuth}.
293+
*/
155294
export type TenantAwareAuth = TTenantAwareAuth;
295+
296+
/**
297+
* Type alias to {@link firebase-admin.auth#TenantManager}.
298+
*/
156299
export type TenantManager = TTenantManager;
300+
301+
/**
302+
* Type alias to {@link firebase-admin.auth#UidIdentifier}.
303+
*/
157304
export type UidIdentifier = TUidIdentifier;
305+
306+
/**
307+
* Type alias to {@link firebase-admin.auth#UpdateAuthProviderRequest}.
308+
*/
158309
export type UpdateAuthProviderRequest = TUpdateAuthProviderRequest;
310+
311+
/**
312+
* Type alias to {@link firebase-admin.auth#UpdateMultiFactorInfoRequest}.
313+
*/
159314
export type UpdateMultiFactorInfoRequest = TUpdateMultiFactorInfoRequest;
315+
316+
/**
317+
* Type alias to {@link firebase-admin.auth#UpdatePhoneMultiFactorInfoRequest}.
318+
*/
160319
export type UpdatePhoneMultiFactorInfoRequest = TUpdatePhoneMultiFactorInfoRequest;
320+
321+
/**
322+
* Type alias to {@link firebase-admin.auth#UpdateRequest}.
323+
*/
161324
export type UpdateRequest = TUpdateRequest;
325+
326+
/**
327+
* Type alias to {@link firebase-admin.auth#UpdateTenantRequest}.
328+
*/
162329
export type UpdateTenantRequest = TUpdateTenantRequest;
330+
331+
/**
332+
* Type alias to {@link firebase-admin.auth#UserIdentifier}.
333+
*/
163334
export type UserIdentifier = TUserIdentifier;
335+
336+
/**
337+
* Type alias to {@link firebase-admin.auth#UserImportOptions}.
338+
*/
164339
export type UserImportOptions = TUserImportOptions;
340+
341+
/**
342+
* Type alias to {@link firebase-admin.auth#UserImportRecord}.
343+
*/
165344
export type UserImportRecord = TUserImportRecord;
345+
346+
/**
347+
* Type alias to {@link firebase-admin.auth#UserImportResult}.
348+
*/
166349
export type UserImportResult = TUserImportResult;
350+
351+
/**
352+
* Type alias to {@link firebase-admin.auth#UserInfo}.
353+
*/
167354
export type UserInfo = TUserInfo;
355+
356+
/**
357+
* Type alias to {@link firebase-admin.auth#UserMetadata}.
358+
*/
168359
export type UserMetadata = TUserMetadata;
360+
361+
/**
362+
* Type alias to {@link firebase-admin.auth#UserMetadataRequest}.
363+
*/
169364
export type UserMetadataRequest = TUserMetadataRequest;
365+
366+
/**
367+
* Type alias to {@link firebase-admin.auth#UserProviderRequest}.
368+
*/
170369
export type UserProviderRequest = TUserProviderRequest;
370+
371+
/**
372+
* Type alias to {@link firebase-admin.auth#UserRecord}.
373+
*/
171374
export type UserRecord = TUserRecord;
172375
}

0 commit comments

Comments
 (0)