|
1 | | -## API Report File for "@firebase/app-check" |
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 { FirebaseApp } from '@firebase/app'; |
8 | | -import { PartialObserver } from '@firebase/util'; |
9 | | -import { Unsubscribe } from '@firebase/util'; |
10 | | - |
11 | | -// @public |
12 | | -export interface AppCheck { |
13 | | - app: FirebaseApp; |
14 | | -} |
15 | | - |
16 | | -// @internal (undocumented) |
17 | | -export type _AppCheckComponentName = 'app-check'; |
18 | | - |
19 | | -// @internal (undocumented) |
20 | | -export type _AppCheckInternalComponentName = 'app-check-internal'; |
21 | | - |
22 | | -// @public |
23 | | -export interface AppCheckOptions { |
24 | | - isTokenAutoRefreshEnabled?: boolean; |
25 | | - provider: CustomProvider | ReCaptchaV3Provider | ReCaptchaEnterpriseProvider; |
26 | | -} |
27 | | - |
28 | | -// @public |
29 | | -export interface AppCheckToken { |
30 | | - readonly expireTimeMillis: number; |
31 | | - // (undocumented) |
32 | | - readonly token: string; |
33 | | -} |
34 | | - |
35 | | -// @public |
36 | | -export type AppCheckTokenListener = (token: AppCheckTokenResult) => void; |
37 | | - |
38 | | -// @public |
39 | | -export interface AppCheckTokenResult { |
40 | | - readonly token: string; |
41 | | -} |
42 | | - |
43 | | -// Warning: (ae-forgotten-export) The symbol "AppCheckProvider" needs to be exported by the entry point index.d.ts |
44 | | -// |
45 | | -// @public |
46 | | -export class CustomProvider implements AppCheckProvider { |
47 | | - constructor(_customProviderOptions: CustomProviderOptions); |
48 | | - // Warning: (ae-forgotten-export) The symbol "AppCheckTokenInternal" needs to be exported by the entry point index.d.ts |
49 | | - // |
50 | | - // @internal (undocumented) |
51 | | - getToken(): Promise<AppCheckTokenInternal>; |
52 | | - // @internal (undocumented) |
53 | | - initialize(app: FirebaseApp): void; |
54 | | - // @internal (undocumented) |
55 | | - isEqual(otherProvider: unknown): boolean; |
56 | | -} |
57 | | - |
58 | | -// @public |
59 | | -export interface CustomProviderOptions { |
60 | | - getToken: () => Promise<AppCheckToken>; |
61 | | -} |
62 | | - |
63 | | -// @public |
64 | | -export function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>; |
65 | | - |
66 | | -// @public |
67 | | -export function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck; |
68 | | - |
69 | | -// @public |
70 | | -export function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe; |
71 | | - |
72 | | -// @public |
73 | | -export function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe; |
74 | | - |
75 | | -export { PartialObserver } |
76 | | - |
77 | | -// @public |
78 | | -export class ReCaptchaEnterpriseProvider implements AppCheckProvider { |
79 | | - constructor(_siteKey: string); |
80 | | - // @internal |
81 | | - getToken(): Promise<AppCheckTokenInternal>; |
82 | | - // @internal (undocumented) |
83 | | - initialize(app: FirebaseApp): void; |
84 | | - // @internal (undocumented) |
85 | | - isEqual(otherProvider: unknown): boolean; |
86 | | - } |
87 | | - |
88 | | -// @public |
89 | | -export class ReCaptchaV3Provider implements AppCheckProvider { |
90 | | - constructor(_siteKey: string); |
91 | | - // @internal |
92 | | - getToken(): Promise<AppCheckTokenInternal>; |
93 | | - // @internal (undocumented) |
94 | | - initialize(app: FirebaseApp): void; |
95 | | - // @internal (undocumented) |
96 | | - isEqual(otherProvider: unknown): boolean; |
97 | | - } |
98 | | - |
99 | | -// @public |
100 | | -export function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void; |
101 | | - |
102 | | -export { Unsubscribe } |
103 | | - |
104 | | - |
105 | | -``` |
| 1 | +## API Report File for "@firebase/app-check" |
| 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 { FirebaseApp } from '@firebase/app'; |
| 8 | +import { PartialObserver } from '@firebase/util'; |
| 9 | +import { Unsubscribe } from '@firebase/util'; |
| 10 | + |
| 11 | +// @public |
| 12 | +export interface AppCheck { |
| 13 | + app: FirebaseApp; |
| 14 | +} |
| 15 | + |
| 16 | +// @internal (undocumented) |
| 17 | +export type _AppCheckComponentName = 'app-check'; |
| 18 | + |
| 19 | +// @internal (undocumented) |
| 20 | +export type _AppCheckInternalComponentName = 'app-check-internal'; |
| 21 | + |
| 22 | +// @public |
| 23 | +export interface AppCheckOptions { |
| 24 | + isTokenAutoRefreshEnabled?: boolean; |
| 25 | + provider: CustomProvider | ReCaptchaV3Provider | ReCaptchaEnterpriseProvider; |
| 26 | +} |
| 27 | + |
| 28 | +// @public |
| 29 | +export interface AppCheckToken { |
| 30 | + readonly expireTimeMillis: number; |
| 31 | + // (undocumented) |
| 32 | + readonly token: string; |
| 33 | +} |
| 34 | + |
| 35 | +// @public |
| 36 | +export type AppCheckTokenListener = (token: AppCheckTokenResult) => void; |
| 37 | + |
| 38 | +// @public |
| 39 | +export interface AppCheckTokenResult { |
| 40 | + readonly token: string; |
| 41 | +} |
| 42 | + |
| 43 | +// Warning: (ae-forgotten-export) The symbol "AppCheckProvider" needs to be exported by the entry point index.d.ts |
| 44 | +// |
| 45 | +// @public |
| 46 | +export class CustomProvider implements AppCheckProvider { |
| 47 | + constructor(_customProviderOptions: CustomProviderOptions); |
| 48 | + // Warning: (ae-forgotten-export) The symbol "AppCheckTokenInternal" needs to be exported by the entry point index.d.ts |
| 49 | + // |
| 50 | + // @internal (undocumented) |
| 51 | + getToken(): Promise<AppCheckTokenInternal>; |
| 52 | + // @internal (undocumented) |
| 53 | + initialize(app: FirebaseApp): void; |
| 54 | + // @internal (undocumented) |
| 55 | + isEqual(otherProvider: unknown): boolean; |
| 56 | +} |
| 57 | + |
| 58 | +// @public |
| 59 | +export interface CustomProviderOptions { |
| 60 | + getToken: () => Promise<AppCheckToken>; |
| 61 | +} |
| 62 | + |
| 63 | +// @public |
| 64 | +export function getToken(appCheckInstance: AppCheck, forceRefresh?: boolean): Promise<AppCheckTokenResult>; |
| 65 | + |
| 66 | +// @public |
| 67 | +export function initializeAppCheck(app: FirebaseApp | undefined, options: AppCheckOptions): AppCheck; |
| 68 | + |
| 69 | +// @public |
| 70 | +export function onTokenChanged(appCheckInstance: AppCheck, observer: PartialObserver<AppCheckTokenResult>): Unsubscribe; |
| 71 | + |
| 72 | +// @public |
| 73 | +export function onTokenChanged(appCheckInstance: AppCheck, onNext: (tokenResult: AppCheckTokenResult) => void, onError?: (error: Error) => void, onCompletion?: () => void): Unsubscribe; |
| 74 | + |
| 75 | +export { PartialObserver } |
| 76 | + |
| 77 | +// @public |
| 78 | +export class ReCaptchaEnterpriseProvider implements AppCheckProvider { |
| 79 | + constructor(_siteKey: string); |
| 80 | + // @internal |
| 81 | + getToken(): Promise<AppCheckTokenInternal>; |
| 82 | + // @internal (undocumented) |
| 83 | + initialize(app: FirebaseApp): void; |
| 84 | + // @internal (undocumented) |
| 85 | + isEqual(otherProvider: unknown): boolean; |
| 86 | + } |
| 87 | + |
| 88 | +// @public |
| 89 | +export class ReCaptchaV3Provider implements AppCheckProvider { |
| 90 | + constructor(_siteKey: string); |
| 91 | + // @internal |
| 92 | + getToken(): Promise<AppCheckTokenInternal>; |
| 93 | + // @internal (undocumented) |
| 94 | + initialize(app: FirebaseApp): void; |
| 95 | + // @internal (undocumented) |
| 96 | + isEqual(otherProvider: unknown): boolean; |
| 97 | + } |
| 98 | + |
| 99 | +// @public |
| 100 | +export function setTokenAutoRefreshEnabled(appCheckInstance: AppCheck, isTokenAutoRefreshEnabled: boolean): void; |
| 101 | + |
| 102 | +export { Unsubscribe } |
| 103 | + |
| 104 | + |
| 105 | +``` |
0 commit comments