Skip to content

Commit

Permalink
chore: Added docstrings to type aliases in namespaces (#1247)
Browse files Browse the repository at this point in the history 
* chore: Adding documentation for type aliases

* chore: Adding more type alias doc strings

* chore: Added documentation to type aliases
  • Loading branch information
@hiranya911
hiranya911 authored May 5, 2021
1 parent 02e2ea2 commit ec08bfc
Show file tree
Hide file tree
Showing 17 changed files with 557 additions and 271 deletions.
253 changes: 1 addition & 252 deletions etc/firebase-admin.api.md
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion etc/firebase-admin.database.api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import { Reference } from '@firebase/database-types';
import * as rtdb from '@firebase/database-types';
import { ThenableReference } from '@firebase/database-types';

// @public (undocumented)
// @public
export interface Database extends FirebaseDatabase {
getRules(): Promise<string>;
getRulesJSON(): Promise<object>;
Expand Down
3 changes: 1 addition & 2 deletions etc/firebase-admin.firestore.api.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ import { DocumentSnapshot } from '@google-cloud/firestore';
import { FieldPath } from '@google-cloud/firestore';
import { FieldValue } from '@google-cloud/firestore';
import { Firestore } from '@google-cloud/firestore';
import * as _firestore from '@google-cloud/firestore';
import { FirestoreDataConverter } from '@google-cloud/firestore';
import { GeoPoint } from '@google-cloud/firestore';
import { GrpcStatus } from '@google-cloud/firestore';
Expand Down Expand Up @@ -64,7 +63,7 @@ export { GeoPoint }
// Warning: (ae-forgotten-export) The symbol "App" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export function getFirestore(app?: App): _firestore.Firestore;
export function getFirestore(app?: App): Firestore;

export { GrpcStatus }

Expand Down
2 changes: 1 addition & 1 deletion package-lock.json
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

44 changes: 33 additions & 11 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -57,17 +57,39 @@
"types": "./lib/index.d.ts",
"typesVersions": {
"*": {
"app": ["lib/app"],
"auth": ["lib/auth"],
"database": ["lib/database"],
"firestore": ["lib/firestore"],
"instance-id": ["lib/instance-id"],
"machine-learning": ["lib/machine-learning"],
"messaging": ["lib/messaging"],
"project-management": ["lib/project-management"],
"remote-config": ["lib/remote-config"],
"security-rules": ["lib/security-rules"],
"storage": ["lib/storage"]
"app": [
"lib/app"
],
"auth": [
"lib/auth"
],
"database": [
"lib/database"
],
"firestore": [
"lib/firestore"
],
"instance-id": [
"lib/instance-id"
],
"machine-learning": [
"lib/machine-learning"
],
"messaging": [
"lib/messaging"
],
"project-management": [
"lib/project-management"
],
"remote-config": [
"lib/remote-config"
],
"security-rules": [
"lib/security-rules"
],
"storage": [
"lib/storage"
]
}
},
"exports": {
Expand Down
203 changes: 203 additions & 0 deletions src/auth/auth-namespace.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -118,55 +118,258 @@ export declare function auth(app?: App): auth.Auth;

/* eslint-disable @typescript-eslint/no-namespace */
export namespace auth {
/**
* Type alias to {@link firebase-admin.auth#ActionCodeSettings}.
*/
export type ActionCodeSettings = TActionCodeSettings;

/**
* Type alias to {@link firebase-admin.auth#Auth}.
*/
export type Auth = TAuth;

/**
* Type alias to {@link firebase-admin.auth#AuthFactorType}.
*/
export type AuthFactorType = TAuthFactorType;

/**
* Type alias to {@link firebase-admin.auth#AuthProviderConfig}.
*/
export type AuthProviderConfig = TAuthProviderConfig;

/**
* Type alias to {@link firebase-admin.auth#AuthProviderConfigFilter}.
*/
export type AuthProviderConfigFilter = TAuthProviderConfigFilter;

/**
* Type alias to {@link firebase-admin.auth#BaseAuth}.
*/
export type BaseAuth = TBaseAuth;

/**
* Type alias to {@link firebase-admin.auth#CreateMultiFactorInfoRequest}.
*/
export type CreateMultiFactorInfoRequest = TCreateMultiFactorInfoRequest;

/**
* Type alias to {@link firebase-admin.auth#CreatePhoneMultiFactorInfoRequest}.
*/
export type CreatePhoneMultiFactorInfoRequest = TCreatePhoneMultiFactorInfoRequest;

/**
* Type alias to {@link firebase-admin.auth#CreateRequest}.
*/
export type CreateRequest = TCreateRequest;

/**
* Type alias to {@link firebase-admin.auth#CreateTenantRequest}.
*/
export type CreateTenantRequest = TCreateTenantRequest;

/**
* Type alias to {@link firebase-admin.auth#DecodedIdToken}.
*/
export type DecodedIdToken = TDecodedIdToken;

/**
* Type alias to {@link firebase-admin.auth#DeleteUsersResult}.
*/
export type DeleteUsersResult = TDeleteUsersResult;

/**
* Type alias to {@link firebase-admin.auth#EmailIdentifier}.
*/
export type EmailIdentifier = TEmailIdentifier;

/**
* Type alias to {@link firebase-admin.auth#EmailSignInProviderConfig}.
*/
export type EmailSignInProviderConfig = TEmailSignInProviderConfig;

/**
* Type alias to {@link firebase-admin.auth#GetUsersResult}.
*/
export type GetUsersResult = TGetUsersResult;

/**
* Type alias to {@link firebase-admin.auth#HashAlgorithmType}.
*/
export type HashAlgorithmType = THashAlgorithmType;

/**
* Type alias to {@link firebase-admin.auth#ListProviderConfigResults}.
*/
export type ListProviderConfigResults = TListProviderConfigResults;

/**
* Type alias to {@link firebase-admin.auth#ListTenantsResult}.
*/
export type ListTenantsResult = TListTenantsResult;

/**
* Type alias to {@link firebase-admin.auth#ListUsersResult}.
*/
export type ListUsersResult = TListUsersResult;

/**
* Type alias to {@link firebase-admin.auth#MultiFactorCreateSettings}.
*/
export type MultiFactorCreateSettings = TMultiFactorCreateSettings;

/**
* Type alias to {@link firebase-admin.auth#MultiFactorConfig}.
*/
export type MultiFactorConfig = TMultiFactorConfig;

/**
* Type alias to {@link firebase-admin.auth#MultiFactorConfigState}.
*/
export type MultiFactorConfigState = TMultiFactorConfigState;

/**
* Type alias to {@link firebase-admin.auth#MultiFactorInfo}.
*/
export type MultiFactorInfo = TMultiFactorInfo;

/**
* Type alias to {@link firebase-admin.auth#MultiFactorUpdateSettings}.
*/
export type MultiFactorUpdateSettings = TMultiFactorUpdateSettings;

/**
* Type alias to {@link firebase-admin.auth#MultiFactorSettings}.
*/
export type MultiFactorSettings = TMultiFactorSettings;

/**
* Type alias to {@link firebase-admin.auth#OIDCAuthProviderConfig}.
*/
export type OIDCAuthProviderConfig = TOIDCAuthProviderConfig;

/**
* Type alias to {@link firebase-admin.auth#OIDCUpdateAuthProviderRequest}.
*/
export type OIDCUpdateAuthProviderRequest = TOIDCUpdateAuthProviderRequest;

/**
* Type alias to {@link firebase-admin.auth#PhoneIdentifier}.
*/
export type PhoneIdentifier = TPhoneIdentifier;

/**
* Type alias to {@link firebase-admin.auth#PhoneMultiFactorInfo}.
*/
export type PhoneMultiFactorInfo = TPhoneMultiFactorInfo;

/**
* Type alias to {@link firebase-admin.auth#ProviderIdentifier}.
*/
export type ProviderIdentifier = TProviderIdentifier;

/**
* Type alias to {@link firebase-admin.auth#SAMLAuthProviderConfig}.
*/
export type SAMLAuthProviderConfig = TSAMLAuthProviderConfig;

/**
* Type alias to {@link firebase-admin.auth#SAMLUpdateAuthProviderRequest}.
*/
export type SAMLUpdateAuthProviderRequest = TSAMLUpdateAuthProviderRequest;

/**
* Type alias to {@link firebase-admin.auth#SessionCookieOptions}.
*/
export type SessionCookieOptions = TSessionCookieOptions;

/**
* Type alias to {@link firebase-admin.auth#Tenant}.
*/
export type Tenant = TTenant;

/**
* Type alias to {@link firebase-admin.auth#TenantAwareAuth}.
*/
export type TenantAwareAuth = TTenantAwareAuth;

/**
* Type alias to {@link firebase-admin.auth#TenantManager}.
*/
export type TenantManager = TTenantManager;

/**
* Type alias to {@link firebase-admin.auth#UidIdentifier}.
*/
export type UidIdentifier = TUidIdentifier;

/**
* Type alias to {@link firebase-admin.auth#UpdateAuthProviderRequest}.
*/
export type UpdateAuthProviderRequest = TUpdateAuthProviderRequest;

/**
* Type alias to {@link firebase-admin.auth#UpdateMultiFactorInfoRequest}.
*/
export type UpdateMultiFactorInfoRequest = TUpdateMultiFactorInfoRequest;

/**
* Type alias to {@link firebase-admin.auth#UpdatePhoneMultiFactorInfoRequest}.
*/
export type UpdatePhoneMultiFactorInfoRequest = TUpdatePhoneMultiFactorInfoRequest;

/**
* Type alias to {@link firebase-admin.auth#UpdateRequest}.
*/
export type UpdateRequest = TUpdateRequest;

/**
* Type alias to {@link firebase-admin.auth#UpdateTenantRequest}.
*/
export type UpdateTenantRequest = TUpdateTenantRequest;

/**
* Type alias to {@link firebase-admin.auth#UserIdentifier}.
*/
export type UserIdentifier = TUserIdentifier;

/**
* Type alias to {@link firebase-admin.auth#UserImportOptions}.
*/
export type UserImportOptions = TUserImportOptions;

/**
* Type alias to {@link firebase-admin.auth#UserImportRecord}.
*/
export type UserImportRecord = TUserImportRecord;

/**
* Type alias to {@link firebase-admin.auth#UserImportResult}.
*/
export type UserImportResult = TUserImportResult;

/**
* Type alias to {@link firebase-admin.auth#UserInfo}.
*/
export type UserInfo = TUserInfo;

/**
* Type alias to {@link firebase-admin.auth#UserMetadata}.
*/
export type UserMetadata = TUserMetadata;

/**
* Type alias to {@link firebase-admin.auth#UserMetadataRequest}.
*/
export type UserMetadataRequest = TUserMetadataRequest;

/**
* Type alias to {@link firebase-admin.auth#UserProviderRequest}.
*/
export type UserProviderRequest = TUserProviderRequest;

/**
* Type alias to {@link firebase-admin.auth#UserRecord}.
*/
export type UserRecord = TUserRecord;
}
Loading

0 comments on commit ec08bfc

Please sign in to comment.