Skip to content

Commit fabcf80

Browse files
committed
feat: add apidocs
1 parent 2a759df commit fabcf80

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed

etc/firebase-admin.fpnv.api.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
## API Report File for "firebase-admin.fpnv"
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 { Agent } from 'http';
8+
9+
// Warning: (ae-forgotten-export) The symbol "PrefixedFirebaseError" needs to be exported by the entry point index.d.ts
10+
//
11+
// @public
12+
export class FirebasePnvError extends PrefixedFirebaseError {
13+
}
14+
15+
// @public
16+
export class Fpnv {
17+
// Warning: (ae-forgotten-export) The symbol "App" needs to be exported by the entry point index.d.ts
18+
constructor(app: App);
19+
get app(): App;
20+
// Warning: (ae-forgotten-export) The symbol "FirebasePhoneNumberTokenVerifier" needs to be exported by the entry point index.d.ts
21+
//
22+
// (undocumented)
23+
protected readonly fpnvVerifier: FirebasePhoneNumberTokenVerifier;
24+
// (undocumented)
25+
verifyToken(idToken: string): Promise<FpnvToken>;
26+
}
27+
28+
// @public (undocumented)
29+
export class FpnvErrorCode {
30+
// (undocumented)
31+
static readonly EXPIRED_TOKEN: ErrorInfo;
32+
// Warning: (ae-forgotten-export) The symbol "ErrorInfo" needs to be exported by the entry point index.d.ts
33+
//
34+
// (undocumented)
35+
static readonly INVALID_ARGUMENT: ErrorInfo;
36+
// (undocumented)
37+
static readonly INVALID_TOKEN: ErrorInfo;
38+
// (undocumented)
39+
static readonly PROJECT_NOT_FOUND: ErrorInfo;
40+
}
41+
42+
// @public
43+
export interface FpnvToken {
44+
[key: string]: any;
45+
// (undocumented)
46+
aud: string;
47+
// (undocumented)
48+
auth_time: number;
49+
// (undocumented)
50+
exp: number;
51+
// (undocumented)
52+
getPhoneNumber(): string;
53+
// (undocumented)
54+
iat: number;
55+
// (undocumented)
56+
iss: string;
57+
// (undocumented)
58+
sub: string;
59+
}
60+
61+
// @public
62+
export function getFirebasePnv(app?: App): Fpnv;
63+
64+
```

0 commit comments

Comments
 (0)