Skip to content

Commit a36d545

Browse files
dwyfrequencydwyfrequency
committed
Switch API docs to lf line endings
1 parent 3176e93 commit a36d545

16 files changed

+3864
-0
lines changed

‎common/api-review/analytics.api.md

Lines changed: 410 additions & 0 deletions
Large diffs are not rendered by default.

‎common/api-review/app-check.api.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,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+
```

‎common/api-review/app.api.md

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
## API Report File for "@firebase/app"
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 { Component } from '@firebase/component';
8+
import { ComponentContainer } from '@firebase/component';
9+
import { FirebaseError } from '@firebase/util';
10+
import { LogCallback } from '@firebase/logger';
11+
import { LogLevelString } from '@firebase/logger';
12+
import { LogOptions } from '@firebase/logger';
13+
import { Name } from '@firebase/component';
14+
import { Provider } from '@firebase/component';
15+
16+
// @internal (undocumented)
17+
export function _addComponent<T extends Name>(app: FirebaseApp, component: Component<T>): void;
18+
19+
// @internal (undocumented)
20+
export function _addOrOverwriteComponent(app: FirebaseApp, component: Component): void;
21+
22+
// @internal (undocumented)
23+
export const _apps: Map<string, FirebaseApp>;
24+
25+
// @internal
26+
export function _clearComponents(): void;
27+
28+
// @internal
29+
export const _components: Map<string, Component<any>>;
30+
31+
// @internal
32+
export const _DEFAULT_ENTRY_NAME = "[DEFAULT]";
33+
34+
// @public
35+
export function deleteApp(app: FirebaseApp): Promise<void>;
36+
37+
// @public
38+
export interface FirebaseApp {
39+
automaticDataCollectionEnabled: boolean;
40+
readonly name: string;
41+
readonly options: FirebaseOptions;
42+
}
43+
44+
// @internal (undocumented)
45+
export interface _FirebaseAppInternal extends FirebaseApp {
46+
// (undocumented)
47+
checkDestroyed(): void;
48+
// (undocumented)
49+
container: ComponentContainer;
50+
// (undocumented)
51+
isDeleted: boolean;
52+
}
53+
54+
// @public
55+
export interface FirebaseAppSettings {
56+
automaticDataCollectionEnabled?: boolean;
57+
name?: string;
58+
}
59+
60+
export { FirebaseError }
61+
62+
// @public
63+
export interface FirebaseOptions {
64+
apiKey?: string;
65+
appId?: string;
66+
authDomain?: string;
67+
databaseURL?: string;
68+
measurementId?: string;
69+
messagingSenderId?: string;
70+
projectId?: string;
71+
storageBucket?: string;
72+
}
73+
74+
// @internal (undocumented)
75+
export interface _FirebaseService {
76+
// (undocumented)
77+
app: FirebaseApp;
78+
_delete(): Promise<void>;
79+
}
80+
81+
// @public
82+
export function getApp(name?: string): FirebaseApp;
83+
84+
// @public
85+
export function getApps(): FirebaseApp[];
86+
87+
// @internal (undocumented)
88+
export function _getProvider<T extends Name>(app: FirebaseApp, name: T): Provider<T>;
89+
90+
// @public
91+
export function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
92+
93+
// @public
94+
export function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
95+
96+
// @public
97+
export function onLog(logCallback: LogCallback | null, options?: LogOptions): void;
98+
99+
// @internal (undocumented)
100+
export function _registerComponent<T extends Name>(component: Component<T>): boolean;
101+
102+
// @public
103+
export function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;
104+
105+
// @internal (undocumented)
106+
export function _removeServiceInstance<T extends Name>(app: FirebaseApp, name: T, instanceIdentifier?: string): void;
107+
108+
// @public
109+
export const SDK_VERSION: string;
110+
111+
// @public
112+
export function setLogLevel(logLevel: LogLevelString): void;
113+
114+
115+
```

0 commit comments

Comments
 (0)