Firebase 앱
이 패키지는 여러 Firebase 구성요소 간의 통신을 조정합니다.
함수
함수 | 설명 |
---|---|
function(앱, ...) | |
deleteApp(앱) | 이 앱을 사용할 수 없게 만들고 연결된 모든 서비스의 리소스를 해제합니다. |
함수() | |
getApps() | 초기화된 모든 앱의 (읽기 전용) 배열입니다. |
initializeApp() | FirebaseApp 인스턴스를 만들고 초기화합니다. |
함수(libraryKeyOrName, ...) | |
registerVersion(libraryKeyOrName, version, variant) | 플랫폼 로깅 목적으로 라이브러리의 이름과 버전을 등록합니다. |
함수(logCallback, ...) | |
onLog(logCallback, options) | 모든 Firebase SDK의 로그 핸들러를 설정합니다. |
function(logLevel, ...) | |
setLogLevel(logLevel) | 모든 Firebase SDK의 로그 수준을 설정합니다.현재 로그 수준보다 높은 모든 로그 유형이 캡처됩니다. 즉, 로그 수준을 info 로 설정하면 오류는 로깅되지만 debug 및 verbose 로그는 로깅되지 않습니다. |
함수(이름, ...) | |
getApp(이름) | FirebaseApp 인스턴스를 검색합니다.인수 없이 호출하면 기본 앱이 반환됩니다. 앱 이름이 제공되면 해당 이름에 해당하는 앱이 반환됩니다.가져오는 앱이 아직 초기화되지 않은 경우 예외가 발생합니다. |
함수(옵션, ...) | |
initializeApp(옵션, 이름) | FirebaseApp 인스턴스를 만들고 초기화합니다.자세한 문서는 앱에 Firebase 추가 및 여러 프로젝트 초기화를 참고하세요. |
initializeApp(옵션, 구성) | FirebaseApp 인스턴스를 만들고 초기화합니다. |
initializeServerApp(옵션, 구성) | FirebaseServerApp 인스턴스를 만들고 초기화합니다.FirebaseServerApp 는 FirebaseApp 와 유사하지만 서버 측 렌더링 환경에서만 실행되도록 설계되었습니다. 브라우저 환경에서 호출하면 초기화가 실패합니다.자세한 내용은 앱에 Firebase 추가 및 여러 프로젝트 초기화를 참고하세요. |
인터페이스
인터페이스 | 설명 |
---|---|
FirebaseApp | FirebaseApp은 서비스 모음의 초기화 정보를 보유합니다.이 생성자를 직접 호출하지 마세요. 대신 initializeApp()을 사용하여 앱을 만드세요. |
FirebaseAppSettings | initializeApp()에 지정된 구성 옵션 |
FirebaseOptions | Firebase 구성 객체입니다. Firebase 서버 API와 성공적으로 통신하고 클라이언트 데이터를 Firebase 프로젝트 및 Firebase 애플리케이션과 연결하는 데 필요한 매개변수 집합이 포함되어 있습니다. 일반적으로 프로젝트 설정 시 Firebase Console에서 이 객체를 채웁니다. Firebase 구성 객체에 대해 알아보기도 참고하세요. |
FirebaseServerApp | FirebaseServerApp은 서버 환경에서 실행되는 서비스 모음의 초기화 정보를 보유합니다.이 생성자를 직접 호출하지 마세요. 대신 initializeServerApp()을 사용하여 앱을 만드세요. |
FirebaseServerAppSettings | initializeServerApp()에 제공되는 구성 옵션 |
변수
변수 | 설명 |
---|---|
SDK_VERSION | 현재 SDK 버전입니다. |
function(앱, ...)
deleteApp(앱)
이 앱을 사용할 수 없게 만들고 연결된 모든 서비스의 리소스를 해제합니다.
Signature:
export declare function deleteApp(app: FirebaseApp): Promise<void>;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
앱 | FirebaseApp |
반환:
Promise<void>
예
deleteApp(app)
.then(function() {
console.log("App deleted successfully");
})
.catch(function(error) {
console.log("Error deleting app:", error);
});
함수()
getApps()
초기화된 모든 앱의 (읽기 전용) 배열입니다.
Signature:
export declare function getApps(): FirebaseApp[];
반환:
initializeApp()
FirebaseApp 인스턴스를 만들고 초기화합니다.
Signature:
export declare function initializeApp(): FirebaseApp;
반환:
function(libraryKeyOrName, ...)
registerVersion(libraryKeyOrName, version, variant)
플랫폼 로깅 목적으로 라이브러리의 이름과 버전을 등록합니다.
Signature:
export declare function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
libraryKeyOrName | 문자열 | |
버전 | 문자열 | 라이브러리의 현재 버전입니다. |
variant | 문자열 | 번들 변형(예: node, rn 등) |
반환:
void
function(logCallback, ...)
onLog(logCallback, options)
모든 Firebase SDK의 로그 핸들러를 설정합니다.
Signature:
export declare function onLog(logCallback: LogCallback | null, options?: LogOptions): void;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
logCallback | LogCallback | null | Firebase SDK가 로깅을 호출할 때마다 사용자 코드를 실행하는 선택적 커스텀 로그 핸들러입니다. |
옵션 | LogOptions |
반환:
void
function(logLevel, ...)
setLogLevel(logLevel)
모든 Firebase SDK의 로그 수준을 설정합니다.
현재 로그 수준보다 높은 모든 로그 유형이 캡처됩니다. 즉, 로그 수준을 info
로 설정하면 오류는 로깅되지만 debug
및 verbose
로그는 로깅되지 않습니다.
Signature:
export declare function setLogLevel(logLevel: LogLevelString): void;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
logLevel | LogLevelString |
반환:
void
function(이름, ...)
getApp(이름)
FirebaseApp 인스턴스를 검색합니다.
인수 없이 호출하면 기본 앱이 반환됩니다. 앱 이름이 제공되면 해당 이름에 해당하는 앱이 반환됩니다.
검색 중인 앱이 아직 초기화되지 않은 경우 예외가 발생합니다.
Signature:
export declare function getApp(name?: string): FirebaseApp;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
이름 | 문자열 | 반환할 앱의 이름(선택사항)입니다. 이름을 제공하지 않으면 기본값은 "[DEFAULT]" 입니다. |
반환:
제공된 앱 이름에 해당하는 앱입니다. 앱 이름을 제공하지 않으면 기본 앱이 반환됩니다.
예시 1
// Return the default app
const app = getApp();
예 2
// Return a named app
const otherApp = getApp("otherApp");
function(옵션, ...)
initializeApp(옵션, 이름)
FirebaseApp 인스턴스를 만들고 초기화합니다.
자세한 내용은 앱에 Firebase 추가 및 여러 프로젝트 초기화를 참고하세요.
Signature:
export declare function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
옵션 | FirebaseOptions | 앱의 서비스를 구성하는 옵션입니다. |
이름 | 문자열 | 초기화할 앱의 이름(선택사항)입니다. 이름을 제공하지 않으면 기본값은 "[DEFAULT]" 입니다. |
반환:
초기화된 앱입니다.
예시 1
// Initialize default app
// Retrieve your own options values by adding a web app on
// https://console.firebase.google.com
initializeApp({
apiKey: "AIza....", // Auth / General Use
authDomain: "YOUR_APP.firebaseapp.com", // Auth with popup/redirect
databaseURL: "https://YOUR_APP.firebaseio.com", // Realtime Database
storageBucket: "YOUR_APP.appspot.com", // Storage
messagingSenderId: "123456789" // Cloud Messaging
});
예 2
// Initialize another app
const otherApp = initializeApp({
databaseURL: "https://<OTHER_DATABASE_NAME>.firebaseio.com",
storageBucket: "<OTHER_STORAGE_BUCKET>.appspot.com"
}, "otherApp");
initializeApp(옵션, 구성)
FirebaseApp 인스턴스를 만들고 초기화합니다.
Signature:
export declare function initializeApp(options: FirebaseOptions, config?: FirebaseAppSettings): FirebaseApp;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
옵션 | FirebaseOptions | 앱의 서비스를 구성하는 옵션입니다. |
config | FirebaseAppSettings | FirebaseApp 구성 |
반환:
initializeServerApp(옵션, 구성)
FirebaseServerApp 인스턴스를 만들고 초기화합니다.
FirebaseServerApp
는 FirebaseApp
와 유사하지만 서버 측 렌더링 환경에서만 실행하기 위한 것입니다. 브라우저 환경에서 호출하면 초기화가 실패합니다.
자세한 내용은 앱에 Firebase 추가 및 여러 프로젝트 초기화를 참고하세요.
Signature:
export declare function initializeServerApp(options: FirebaseOptions | FirebaseApp, config: FirebaseServerAppSettings): FirebaseServerApp;
매개변수
매개변수 | 유형 | 설명 |
---|---|---|
옵션 | FirebaseOptions | FirebaseApp | 앱의 서비스를 구성하기 위한 Firebase.AppOptions 또는 내부에 AppOptions 가 포함된 FirebaseApp 인스턴스 |
config | FirebaseServerAppSettings | FirebaseServerApp 구성 |
반환:
초기화된 FirebaseServerApp
입니다.
예
// Initialize an instance of `FirebaseServerApp`.
// Retrieve your own options values by adding a web app on
// https://console.firebase.google.com
initializeServerApp({
apiKey: "AIza....", // Auth / General Use
authDomain: "YOUR_APP.firebaseapp.com", // Auth with popup/redirect
databaseURL: "https://YOUR_APP.firebaseio.com", // Realtime Database
storageBucket: "YOUR_APP.appspot.com", // Storage
messagingSenderId: "123456789" // Cloud Messaging
},
{
authIdToken: "Your Auth ID Token"
});
SDK_VERSION
현재 SDK 버전입니다.
Signature:
SDK_VERSION: string