Skip to content

set up docgen and api review for packages-exp #2868

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

Merged
merged 17 commits into from
Apr 4, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
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
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
*.json linguist-language=JSON-with-Comments
10 changes: 10 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -81,3 +81,13 @@ typings/

# NPM Lockfiles
package-lock.json

# temp folder used by api-extractor
temp
packages-exp/**/temp

# temp markdowns generated for individual SDKs
packages-exp/**/docs

# files generated by api-extractor that should not be tracked
tsdoc-metadata.json
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@
// Exclude installed dependencies from searches too
"**/node_modules": true
},
"typescript.tsdk": "node_modules/typescript/lib"
"typescript.tsdk": "node_modules/typescript/lib",
"files.associations": { "*.json": "jsonc" }
}
44 changes: 44 additions & 0 deletions common/api-review/app-exp.api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
## API Report File for "@firebase/app-exp"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

import { FirebaseApp } from '@firebase/app-types-exp';
import { FirebaseAppConfig } from '@firebase/app-types-exp';
import { FirebaseOptions } from '@firebase/app-types-exp';
import { LogCallback } from '@firebase/logger';
import { LogLevel } from '@firebase/logger';
import { LogOptions } from '@firebase/logger';

// @public
export function deleteApp(app: FirebaseApp): Promise<void>;

// @public
export function getApp(name?: string): FirebaseApp;

// @public
export function getApps(): FirebaseApp[];

// @public
export function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;

// @public
export function initializeApp(options: FirebaseOptions, config?: FirebaseAppConfig): FirebaseApp;

export { LogLevel }

// @public
export function onLog(logCallback: LogCallback | null, options?: LogOptions): void;

// @public
export function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;

// @public
export const SDK_VERSION: string;

// @public
export function setLogLevel(logLevel: LogLevel): void;


```
65 changes: 65 additions & 0 deletions common/api-review/app-types-exp.api.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
## API Report File for "@firebase/app-types-exp"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

import { ComponentContainer } from '@firebase/component';

// @public
export interface FirebaseApp {
automaticDataCollectionEnabled: boolean;

readonly name: string;

readonly options: FirebaseOptions;
}

// @public (undocumented)
export interface FirebaseAppConfig {
// (undocumented)
automaticDataCollectionEnabled?: boolean;
// (undocumented)
name?: string;
}

// @internal (undocumented)
export interface _FirebaseAppInternal extends FirebaseApp {
// (undocumented)
checkDestroyed(): void;
// (undocumented)
container: ComponentContainer;
// (undocumented)
isDeleted: boolean;
}

// @public (undocumented)
export interface FirebaseOptions {
// (undocumented)
apiKey?: string;
// (undocumented)
appId?: string;
// (undocumented)
authDomain?: string;
// (undocumented)
databaseURL?: string;
// (undocumented)
measurementId?: string;
// (undocumented)
messagingSenderId?: string;
// (undocumented)
projectId?: string;
// (undocumented)
storageBucket?: string;
}

// @public (undocumented)
export interface PlatformLoggerService {
// (undocumented)
getPlatformInfoString(): string;
}


// (No @packageDocumentation comment for this package)

```
Loading