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: Added docstrings to type aliases in namespaces #1247

Merged
merged 3 commits into from
May 5, 2021
Merged
Changes from 1 commit
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
Next Next commit
chore: Adding documentation for type aliases
hiranya911 committed Apr 30, 2021

Verified

This commit was signed with the committer’s verified signature.
aeschli Martin Aeschlimann
commit 562dfd79f57f4e9b2ddbde1888e4d3e1a919b1ed
10 changes: 0 additions & 10 deletions etc/firebase-admin.api.md
Original file line number Diff line number Diff line change
@@ -62,24 +62,14 @@ export function auth(app?: App): auth.Auth;
// @public (undocumented)
export namespace auth {
// Warning: (ae-forgotten-export) The symbol "ActionCodeSettings" needs to be exported by the entry point default-namespace.d.ts
//
// (undocumented)
export type ActionCodeSettings = ActionCodeSettings;
// Warning: (ae-forgotten-export) The symbol "Auth" needs to be exported by the entry point default-namespace.d.ts
//
// (undocumented)
export type Auth = Auth;
// Warning: (ae-forgotten-export) The symbol "AuthFactorType" needs to be exported by the entry point default-namespace.d.ts
//
// (undocumented)
export type AuthFactorType = AuthFactorType;
// Warning: (ae-forgotten-export) The symbol "AuthProviderConfig" needs to be exported by the entry point default-namespace.d.ts
//
// (undocumented)
export type AuthProviderConfig = AuthProviderConfig;
// Warning: (ae-forgotten-export) The symbol "AuthProviderConfigFilter" needs to be exported by the entry point default-namespace.d.ts
//
// (undocumented)
export type AuthProviderConfigFilter = AuthProviderConfigFilter;
// Warning: (ae-forgotten-export) The symbol "BaseAuth" needs to be exported by the entry point default-namespace.d.ts
//
19 changes: 19 additions & 0 deletions src/auth/auth-namespace.ts
Original file line number Diff line number Diff line change
@@ -118,10 +118,29 @@ 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;
export type BaseAuth = TBaseAuth;
export type CreateMultiFactorInfoRequest = TCreateMultiFactorInfoRequest;