database package

Firebase 실시간 데이터베이스

기능

클래스

인터페이스

유형 별칭

기능 (앱, ...)

getDatabase (앱, URL)

제공된 FireBaseApp 과 관련된 실시간 데이터베이스 SDK의 인스턴스를 반환합니다. . 인스턴스가 없거나 기존 인스턴스가 사용자 정의 데이터베이스 URL을 사용하는 경우 기본 설정으로 새 인스턴스를 초기화합니다.

서명:

export declare function getDatabase(app?: FirebaseApp, url?: string): Database;

매개변수

보고:

데이터 베이스

제공된 앱의 Database 인스턴스.

기능 (db, ...)

ConnectDatabaseemulator (DB, 호스트, 포트, 옵션)

제공된 인스턴스를 수정하여 실시간 데이터베이스 에뮬레이터와 통신하십시오.

참고 : 다른 작업을 수행하기 전에이 방법을 호출해야합니다.

서명:

export declare function connectDatabaseEmulator(db: Database, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

매개변수

보고:

무효의

구프 플린 (DB)

서버에서 연결을 끊습니다 (모든 데이터베이스 작업은 오프라인으로 완료됩니다).

클라이언트는 자동으로 데이터베이스 서버에 대한 지속적인 연결을 유지하며, 이는 무기한 활성으로 유지되며 연결이 끊어지면 다시 연결됩니다. 그러나 goOffline() 및 goOnline() 메소드는 지속적으로 연결이 바람직하지 않은 경우 클라이언트 연결을 제어하는 ​​데 사용될 수 있습니다.

오프라인에서 클라이언트는 더 이상 데이터베이스에서 데이터 업데이트를받지 않습니다. 그러나 로컬로 수행 된 모든 데이터베이스 작업은 즉시 이벤트를 계속 발사하여 응용 프로그램이 정상적으로 계속 행동 할 수 있습니다. 또한 로컬로 수행되는 각 작업은 데이터베이스 서버와 다시 연결하면 자동으로 대기 및 retried됩니다.

데이터베이스에 다시 연결하고 원격 이벤트 수신을 시작하려면 goOnline() 참조하십시오. .

서명:

export declare function goOffline(db: Database): void;

매개변수

보고:

무효의

Goonline (DB)

서버에 다시 연결하고 오프라인 데이터베이스 상태를 서버 상태와 동기화합니다.

이 방법은 goOffline() 와의 활성 연결을 비활성화 한 후 사용해야합니다. . 다시 연결되면 클라이언트는 적절한 데이터를 전송하고 적절한 이벤트를 발사하여 클라이언트가 자동으로 "캐치"합니다.

서명:

export declare function goOnline(db: Database): void;

매개변수

보고:

무효의

ref (db, path)

제공된 경로에 해당하는 데이터베이스의 위치를 ​​나타내는 Reference 반환합니다. 경로가 제공되지 않으면 Reference 데이터베이스의 루트를 가리 킵니다.

서명:

export declare function ref(db: Database, path?: string): DatabaseReference;

매개변수

보고:

DatabaseReference

경로가 제공되면 제공된 경로를 가리키는 Reference . 그렇지 않으면 데이터베이스의 루트를 가리키는 Reference .

Reffromurl (db, url)

제공된 FireBase URL에 해당하는 데이터베이스의 위치를 ​​나타내는 Reference 반환합니다.

URL이 유효한 Firebase 데이터베이스 URL이 아니거나 현재 Database 인스턴스와 다른 도메인이있는 경우 예외가 발생합니다.

모든 쿼리 매개 변수 ( orderBy , limitToLast 등)는 무시되며 반환 된 Reference 에 적용되지 않습니다. .

서명:

export declare function refFromURL(db: Database, url: string): DatabaseReference;

매개변수

보고:

DatabaseReference

제공된 Firebase URL을 가리키는 Reference .

기능()

forcelongpolling ()

WebSockets 대신 Longpolling의 사용을 강요하십시오. WebSocket 프로토콜이 DatabaseUrl에서 사용되는 경우 이는 무시됩니다.

서명:

export declare function forceLongPolling(): void;

보고:

무효의

ForceWebsockets ()

Longpolling 대신 Websockets의 사용을 강요하십시오.

서명:

export declare function forceWebSockets(): void;

보고:

무효의

OrderBykey ()

키에 따라 주문하는 새로운 QueryConstraint 만듭니다.

쿼리 결과를 (오름차순) 키 값으로 정렬합니다.

정렬 데이터 에서 orderByKey() 에 대해 자세히 읽을 수 있습니다. .

서명:

export declare function orderByKey(): QueryConstraint;

보고:

QueryConstraint

OrderByPriority ()

우선 순위에 따라 주문하는 새로운 QueryConstraint 만듭니다.

응용 프로그램은 우선 순위를 사용할 필요는 없지만 일반적인 속성으로 컬렉션을 주문할 수 있습니다 (우선 순위에 대한 대안은 정렬 데이터를 참조하십시오.

서명:

export declare function orderByPriority(): QueryConstraint;

보고:

QueryConstraint

OrderByValue ()

가치별로 주문하는 새로운 QueryConstraint 만듭니다.

쿼리의 어린이가 모두 스칼라 값 (문자열, 숫자 또는 부울) 인 경우 (오름차순) 값으로 결과를 주문할 수 있습니다.

정렬 데이터 에서 orderByValue() 에 대한 자세한 내용을 읽을 수 있습니다. .

서명:

export declare function orderByValue(): QueryConstraint;

보고:

QueryConstraint

servertimestamp ()

Firebase 서버에 의해 결정된 현재 타임 스탬프 (UNIX 에포크 이후의 시간)를 자동으로 인출하기위한 자리 표시 자 값을 반환합니다.

서명:

export declare function serverTimestamp(): object;

보고:

물체

기능 (델타, ...)

증분 (델타)

제공된 델타에 의해 현재 데이터베이스 값을 원자 적으로 증가시키는 데 사용할 수있는 자리 표시 자 값을 반환합니다.

서명:

export declare function increment(delta: number): object;

매개변수

보고:

물체

데이터 수정을위한 자리 표시 자 값.

함수 (enabled, ...)

활성화 (활성화, 영구)

디버깅 정보를 콘솔에 로그인합니다.

서명:

export declare function enableLogging(enabled: boolean, persistent?: boolean): any;

매개변수

보고:

어느

함수 (한계, ...)

limittofirst (한계)

첫 번째 특정 수의 어린이로 제한되는 새로운 QueryConstraint 만듭니다.

limitToFirst() 메소드는 주어진 콜백에 대해 최대 수의 어린이 수를 설정하는 데 사용됩니다. 제한을 100으로 설정하면 처음에는 최대 100 개의 child_added 이벤트 만받습니다. 데이터베이스에 100 개 미만의 메시지가 저장된 경우 child_added 이벤트가 각 메시지마다 시작됩니다. 그러나 100 개가 넘는 메시지가있는 경우 처음 100 개의 주문 메시지에 대한 child_added 이벤트 만받습니다. 항목이 변경됨에 따라 활성 목록에서 탈락하여 총 숫자가 100으로 유지되는 각 항목에 대해 child_removed 이벤트를 받게됩니다.

필터링 데이터 에서 limitToFirst() 에 대한 자세한 내용을 읽을 수 있습니다. .

서명:

export declare function limitToFirst(limit: number): QueryConstraint;

매개변수

보고:

QueryConstraint

limittolast (한계)

마지막으로 지정된 어린이 수만 반환하도록 제한되는 새로운 QueryConstraint 만듭니다.

limitToLast() 방법은 주어진 콜백에 대해 최대 수의 어린이 수를 설정하는 데 사용됩니다. 제한을 100으로 설정하면 처음에는 최대 100 개의 child_added 이벤트 만받습니다. 데이터베이스에 100 개 미만의 메시지가 저장된 경우 child_added 이벤트가 각 메시지마다 시작됩니다. 그러나 100 개가 넘는 메시지가있는 경우 지난 100 개의 주문 메시지에 대한 child_added 이벤트 만받습니다. 항목이 변경됨에 따라 활성 목록에서 탈락하여 총 숫자가 100으로 유지되는 각 항목에 대해 child_removed 이벤트를 받게됩니다.

필터링 데이터 에서 limitToLast() 에 대한 자세한 내용을 읽을 수 있습니다. .

서명:

export declare function limitToLast(limit: number): QueryConstraint;

매개변수

보고:

QueryConstraint

기능 (로거, ...)

enablegging (로거)

디버깅 정보를 콘솔에 로그인합니다.

서명:

export declare function enableLogging(logger: (message: string) => unknown): any;

매개변수

보고:

어느

기능 (부모, ...)

자녀 (부모, 경로)

지정된 상대 경로에서 위치에 대한 Reference 가져옵니다.

상대 경로는 간단한 자식 이름 (예 : "Ada")이거나 더 깊은 슬래시로 구분 된 경로 (예 : "Ada/Name/First") 일 수 있습니다.

서명:

export declare function child(parent: DatabaseReference, path: string): DatabaseReference;

매개변수

보고:

DatabaseReference

지정된 아동 위치.

푸시 (부모, 가치)

고유 한 키를 사용하여 새 아동 위치를 생성하고 Reference 반환합니다. .

이것은 항목 모음에 데이터를 추가하는 가장 일반적인 패턴입니다.

push() 값을 제공하는 경우 , 값은 생성 된 위치에 기록됩니다. 값을 전달하지 않으면 데이터베이스에 기록 된 것이없고 자식은 비어 있습니다 (그러나 다른 곳에서는 Reference 사용할 수 있습니다).

push() 에 의해 생성 된 고유 키는 현재 시간에 따라 주문되므로 결과 항목 목록은 시간순으로 정렬됩니다. 키는 또한 가용성이 없도록 설계되었습니다 (72 개의 임의의 엔트로피가 포함되어 있음).

데이터 목록에 대한 추가 사항을 참조하십시오 . 고유 식별자를 보장하는 2^120 방법을 참조하십시오. .

서명:

export declare function push(parent: DatabaseReference, value?: unknown): ThenableReference;

매개변수

보고:

그런 다음 회의

결합 된 Promise 과 Reference ; 쓰기가 완료되면 해결되지만 아동 위치에 대한 Reference 로 즉시 사용할 수 있습니다.

기능 (Path, ...)

OrderBychild (Path)

지정된 자식 키가 주문하는 새로운 QueryConstraint 만듭니다.

쿼리는 한 번에 하나의 키로만 주문할 수 있습니다. 동일한 쿼리에서 orderByChild() 여러 번 호출하는 것은 오류입니다.

FireBase 쿼리를 사용하면 모든 어린이 키가 즉시 데이터를 주문할 수 있습니다. 그러나 인덱스가 무엇인지 미리 알면 보안 규칙의 .indexon 규칙을 통해 인덱스를 정의 할 수 있습니다. 자세한 내용은 https://firebase.google.com/docs/database/security/indexing-data 규칙을 참조하십시오.

정렬 데이터 에서 orderByChild() 에 대해 자세히 알아볼 수 있습니다. .

서명:

export declare function orderByChild(path: string): QueryConstraint;

매개변수

보고:

QueryConstraint

함수 (query, ...)

get (query)

이 쿼리에서 최신 결과를 얻습니다.

서명:

export declare function get(query: Query): Promise<DataSnapshot>;

매개변수

보고:

약속 < dataSnapShot >

값을 사용할 수있는 경우 결과 DataSNAPShot로 해결하거나 클라이언트가 값을 반환 할 수없는 경우 거부하는 Promise (예 : 서버가 연락 할 수없고 캐시 된 것이없는 경우).

OFF (Query, EventType, Callback)

on*() ( onValue )에 해당하는 콜백을 분리합니다. , onChildAdded ) 리스너. 참고 : 이것은 리스너를 제거하는 권장 방법이 아닙니다. 대신, 각각 on* 콜백에서 반환 된 콜백 함수를 사용하십시오.

on*() 에 이전에 첨부 된 콜백을 분리하십시오. . 상위 청취자에서 off() 호출해도 자식 노드에 등록 된 리스너를 자동으로 제거하지는 않으며, 콜백을 제거하려면 자식 청취자에게 off() 도 호출해야합니다.

콜백이 지정되지 않으면 지정된 이벤트 타입의 모든 콜백이 제거됩니다. 마찬가지로, 이벤트 유형이 지정되지 않으면 Reference 위한 모든 콜백이 제거됩니다.

구독 취소 콜백을 호출하여 개별 청취자를 제거 할 수도 있습니다.

서명:

export declare function off(query: Query, eventType?: EventType, callback?: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown): void;

매개변수

보고:

무효의

OnChildAdded (쿼리, 콜백, CancelCallback)

특정 위치에서 데이터 변경에 대해서는 청취합니다.

이것은 데이터베이스에서 데이터를 읽는 주요 방법입니다. 초기 데이터와 데이터가 변경 될 때마다 콜백이 트리거됩니다. 반품되지 않은 구독 수신 콜백을 호출하여 업데이트 수신을 중지하십시오. 자세한 내용은 웹에서 데이터 검색을 참조하십시오.

이 위치에서 각 초기 어린이마다 onChildAdded 이벤트가 한 번 트리거되며 새 자녀가 추가 될 때마다 다시 트리거됩니다. 콜백에 전달 된 DataSnapshot 관련 아동의 데이터를 반영합니다. 순서 목적으로, 그것은 null 순서로 이전 형제 자녀의 열쇠를 포함하는 문자열 인 두 번째 인수가 전달됩니다.

서명:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName?: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

매개변수

보고:

구독 취소

리스너를 제거하기 위해 호출 할 수있는 함수.

onchildadded (쿼리, 콜백, 옵션)

특정 위치에서 데이터 변경에 대해서는 청취합니다.

이것은 데이터베이스에서 데이터를 읽는 주요 방법입니다. 초기 데이터와 데이터가 변경 될 때마다 콜백이 트리거됩니다. 반품되지 않은 구독 수신 콜백을 호출하여 업데이트 수신을 중지하십시오. 자세한 내용은 웹에서 데이터 검색을 참조하십시오.

이 위치에서 각 초기 어린이마다 onChildAdded 이벤트가 한 번 트리거되며 새 자녀가 추가 될 때마다 다시 트리거됩니다. 콜백에 전달 된 DataSnapshot 관련 아동의 데이터를 반영합니다. 순서 목적으로, 그것은 null 순서로 이전 형제 자녀의 열쇠를 포함하는 문자열 인 두 번째 인수가 전달됩니다.

서명:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

매개변수

보고:

구독 취소

리스너를 제거하기 위해 호출 할 수있는 함수.

OnChildAdded (쿼리, 콜백, CancelCallback, 옵션)

특정 위치에서 데이터 변경에 대해서는 청취합니다.

이것은 데이터베이스에서 데이터를 읽는 주요 방법입니다. 초기 데이터와 데이터가 변경 될 때마다 콜백이 트리거됩니다. 반품되지 않은 구독 수신 콜백을 호출하여 업데이트 수신을 중지하십시오. 자세한 내용은 웹에서 데이터 검색을 참조하십시오.

이 위치에서 각 초기 어린이마다 onChildAdded 이벤트가 한 번 트리거되며 새 자녀가 추가 될 때마다 다시 트리거됩니다. 콜백에 전달 된 DataSnapshot 관련 아동의 데이터를 반영합니다. 순서 목적으로, 그것은 null 순서로 이전 형제 자녀의 열쇠를 포함하는 문자열 인 두 번째 인수가 전달됩니다.

서명:

export declare function onChildAdded(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

매개변수

보고:

구독 취소

리스너를 제거하기 위해 호출 할 수있는 함수.

OnChildChanged (쿼리, 콜백, CancelCallback)

특정 위치에서 데이터 변경에 대해서는 청취합니다.

이것은 데이터베이스에서 데이터를 읽는 주요 방법입니다. 초기 데이터와 데이터가 변경 될 때마다 콜백이 트리거됩니다. 반품되지 않은 구독 수신 콜백을 호출하여 업데이트 수신을 중지하십시오. 자세한 내용은 웹에서 데이터 검색을 참조하십시오.

어린이 (또는 자손)에 저장된 데이터가 변경되면 onChildChanged 이벤트가 트리거됩니다. 하나의 child_changed 이벤트는 어린이의 여러 변화를 나타낼 수 있습니다. 콜백에 전달 된 DataSnapshot 에는 새로운 자식 내용이 포함됩니다. 순서를 위해, 콜백은 또한 정렬 순서로 이전 형제 자녀의 키를 포함하는 문자열 인 두 번째 인수 또는 첫 번째 자녀 인 경우 null 입니다.

서명:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

매개변수

보고:

구독 취소

리스너를 제거하기 위해 호출 할 수있는 함수.

OnChildChanged (쿼리, 콜백, 옵션)

특정 위치에서 데이터 변경에 대해서는 청취합니다.

이것은 데이터베이스에서 데이터를 읽는 주요 방법입니다. 초기 데이터와 데이터가 변경 될 때마다 콜백이 트리거됩니다. 반품되지 않은 구독 수신 콜백을 호출하여 업데이트 수신을 중지하십시오. 자세한 내용은 웹에서 데이터 검색을 참조하십시오.

어린이 (또는 자손)에 저장된 데이터가 변경되면 onChildChanged 이벤트가 트리거됩니다. 하나의 child_changed 이벤트는 어린이의 여러 변화를 나타낼 수 있습니다. 콜백에 전달 된 DataSnapshot 에는 새로운 자식 내용이 포함됩니다. 순서를 위해, 콜백은 또한 정렬 순서로 이전 형제 자녀의 키를 포함하는 문자열 인 두 번째 인수 또는 첫 번째 자녀 인 경우 null 입니다.

서명:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

매개변수

보고:

구독 취소

리스너를 제거하기 위해 호출 할 수있는 함수.

OnChildChanged (쿼리, 콜백, CancelCallback, 옵션)

특정 위치에서 데이터 변경에 대해서는 청취합니다.

이것은 데이터베이스에서 데이터를 읽는 주요 방법입니다. 초기 데이터와 데이터가 변경 될 때마다 콜백이 트리거됩니다. 반품되지 않은 구독 수신 콜백을 호출하여 업데이트 수신을 중지하십시오. 자세한 내용은 웹에서 데이터 검색을 참조하십시오.

어린이 (또는 자손)에 저장된 데이터가 변경되면 onChildChanged 이벤트가 트리거됩니다. 하나의 child_changed 이벤트는 어린이의 여러 변화를 나타낼 수 있습니다. 콜백에 전달 된 DataSnapshot 에는 새로운 자식 내용이 포함됩니다. 순서를 위해, 콜백은 또한 정렬 순서로 이전 형제 자녀의 키를 포함하는 문자열 인 두 번째 인수 또는 첫 번째 자녀 인 경우 null 입니다.

서명:

export declare function onChildChanged(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

매개변수

보고:

구독 취소

리스너를 제거하기 위해 호출 할 수있는 함수.

OnChildMoved (쿼리, 콜백, CancelCallback)

특정 위치에서 데이터 변경에 대해서는 청취합니다.

이것은 데이터베이스에서 데이터를 읽는 주요 방법입니다. 초기 데이터와 데이터가 변경 될 때마다 콜백이 트리거됩니다. 반품되지 않은 구독 수신 콜백을 호출하여 업데이트 수신을 중지하십시오. 자세한 내용은 웹에서 데이터 검색을 참조하십시오.

자녀의 정렬 주문이 형제 자매에 대한 위치가 바뀌도록 변경되면 onChildMoved 이벤트가 트리거됩니다. 콜백으로 전달 된 DataSnapshot 은 이사 한 어린이의 데이터를위한 것입니다. 또한 이전 형제 자녀의 열쇠를 포함하는 문자열 인 두 번째 인수가 정렬 순서로 전달되거나 첫 번째 자녀 인 경우 null .

서명:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

매개변수

보고:

구독 취소

리스너를 제거하기 위해 호출 할 수있는 함수.

OnChildMoved (쿼리, 콜백, 옵션)

특정 위치에서 데이터 변경에 대해서는 청취합니다.

이것은 데이터베이스에서 데이터를 읽는 주요 방법입니다. 초기 데이터와 데이터가 변경 될 때마다 콜백이 트리거됩니다. 반품되지 않은 구독 수신 콜백을 호출하여 업데이트 수신을 중지하십시오. 자세한 내용은 웹에서 데이터 검색을 참조하십시오.

자녀의 정렬 주문이 형제 자매에 대한 위치가 바뀌도록 변경되면 onChildMoved 이벤트가 트리거됩니다. 콜백으로 전달 된 DataSnapshot 은 이사 한 어린이의 데이터를위한 것입니다. 또한 이전 형제 자녀의 열쇠를 포함하는 문자열 인 두 번째 인수가 정렬 순서로 전달되거나 첫 번째 자녀 인 경우 null .

서명:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, options: ListenOptions): Unsubscribe;

매개변수

보고:

구독 취소

리스너를 제거하기 위해 호출 할 수있는 함수.

OnChildMoved (쿼리, 콜백, CancelCallback, 옵션)

특정 위치에서 데이터 변경에 대해서는 청취합니다.

이것은 데이터베이스에서 데이터를 읽는 주요 방법입니다. 초기 데이터와 데이터가 변경 될 때마다 콜백이 트리거됩니다. 반품되지 않은 구독 수신 콜백을 호출하여 업데이트 수신을 중지하십시오. 자세한 내용은 웹에서 데이터 검색을 참조하십시오.

자녀의 정렬 주문이 형제 자매에 대한 위치가 바뀌도록 변경되면 onChildMoved 이벤트가 트리거됩니다. 콜백으로 전달 된 DataSnapshot 은 이사 한 어린이의 데이터를위한 것입니다. 또한 이전 형제 자녀의 열쇠를 포함하는 문자열 인 두 번째 인수가 정렬 순서로 전달되거나 첫 번째 자녀 인 경우 null .

서명:

export declare function onChildMoved(query: Query, callback: (snapshot: DataSnapshot, previousChildName: string | null) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

매개변수

보고:

구독 취소

리스너를 제거하기 위해 호출 할 수있는 함수.

OnChildRemoved (Query, Callback, CancelCallback)

특정 위치에서 데이터 변경에 대해서는 청취합니다.

이것은 데이터베이스에서 데이터를 읽는 주요 방법입니다. 초기 데이터와 데이터가 변경 될 때마다 콜백이 트리거됩니다. 반품되지 않은 구독 수신 콜백을 호출하여 업데이트 수신을 중지하십시오. 자세한 내용은 웹에서 데이터 검색을 참조하십시오.

onChildRemoved 이벤트는 어린이가 제거 될 때마다 한 번 트리거됩니다. 콜백에 전달 된 DataSnapshot 제거 된 어린이의 이전 데이터가됩니다. 어린이는 다음 중 하나를 제거합니다.

• 고객은 그 자녀 또는 조상 중 한 명에 대한 remove() 대한 명시 적으로 호출 - 어린이 또는 조상 중 한 명에 대한 고객 통화 set(null) - 그 자녀가 모든 자녀를 제거했습니다. 현재 필터링하는 쿼리가 있습니다. 아이를 아웃으로 (정렬 순서가 변경되었거나 최대 한도가 맞았 기 때문에)

서명:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

매개변수

보고:

구독 취소

리스너를 제거하기 위해 호출 할 수있는 함수.

OnChildRemoved (쿼리, 콜백, 옵션)

특정 위치에서 데이터 변경에 대해서는 청취합니다.

이것은 데이터베이스에서 데이터를 읽는 주요 방법입니다. 초기 데이터와 데이터가 변경 될 때마다 콜백이 트리거됩니다. 반품되지 않은 구독 수신 콜백을 호출하여 업데이트 수신을 중지하십시오. 자세한 내용은 웹에서 데이터 검색을 참조하십시오.

onChildRemoved 이벤트는 어린이가 제거 될 때마다 한 번 트리거됩니다. 콜백에 전달 된 DataSnapshot 제거 된 어린이의 이전 데이터가됩니다. 어린이는 다음 중 하나를 제거합니다.

• 고객은 그 자녀 또는 조상 중 한 명에 대한 remove() 대한 명시 적으로 호출 - 어린이 또는 조상 중 한 명에 대한 고객 통화 set(null) - 그 자녀가 모든 자녀를 제거했습니다. 현재 필터링하는 쿼리가 있습니다. 아이를 아웃으로 (정렬 순서가 변경되었거나 최대 한도가 맞았 기 때문에)

서명:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

매개변수

보고:

구독 취소

리스너를 제거하기 위해 호출 할 수있는 함수.

OnChildRemoved (쿼리, 콜백, CancelCallback, 옵션)

특정 위치에서 데이터 변경에 대해서는 청취합니다.

이것은 데이터베이스에서 데이터를 읽는 주요 방법입니다. 초기 데이터와 데이터가 변경 될 때마다 콜백이 트리거됩니다. 반품되지 않은 구독 수신 콜백을 호출하여 업데이트 수신을 중지하십시오. 자세한 내용은 웹에서 데이터 검색을 참조하십시오.

onChildRemoved 이벤트는 어린이가 제거 될 때마다 한 번 트리거됩니다. 콜백에 전달 된 DataSnapshot 제거 된 어린이의 이전 데이터가됩니다. 어린이는 다음 중 하나를 제거합니다.

• 고객은 그 자녀 또는 조상 중 한 명에 대한 remove() 대한 명시 적으로 호출 - 어린이 또는 조상 중 한 명에 대한 고객 통화 set(null) - 그 자녀가 모든 자녀를 제거했습니다. 현재 필터링하는 쿼리가 있습니다. 아이를 아웃으로 (정렬 순서가 변경되었거나 최대 한도가 맞았 기 때문에)

서명:

export declare function onChildRemoved(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

매개변수

보고:

구독 취소

리스너를 제거하기 위해 호출 할 수있는 함수.

OnValue (쿼리, 콜백, CancelCallback)

특정 위치에서 데이터 변경에 대해서는 청취합니다.

이것은 데이터베이스에서 데이터를 읽는 주요 방법입니다. 초기 데이터와 데이터가 변경 될 때마다 콜백이 트리거됩니다. 반품되지 않은 구독 수신 콜백을 호출하여 업데이트 수신을 중지하십시오. 자세한 내용은 웹에서 데이터 검색을 참조하십시오.

이 위치에 저장된 초기 데이터를 사용하여 onValue 이벤트가 한 번 트리거 된 다음 데이터가 변경 될 때마다 다시 트리거됩니다. 콜백으로 전달 된 DataSnapshot on() 호출되는 위치를위한 것입니다. 전체 내용이 동기화 될 때까지 트리거되지 않습니다. 위치에 데이터가없는 경우 빈 DataSnapshot ( val() 이 null 반환하여 트리거됩니다. ).

서명:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback?: (error: Error) => unknown): Unsubscribe;

매개변수

보고:

구독 취소

리스너를 제거하기 위해 호출 할 수있는 함수.

OnValue (쿼리, 콜백, 옵션)

특정 위치에서 데이터 변경에 대해서는 청취합니다.

이것은 데이터베이스에서 데이터를 읽는 주요 방법입니다. 초기 데이터와 데이터가 변경 될 때마다 콜백이 트리거됩니다. 반품되지 않은 구독 수신 콜백을 호출하여 업데이트 수신을 중지하십시오. 자세한 내용은 웹에서 데이터 검색을 참조하십시오.

이 위치에 저장된 초기 데이터를 사용하여 onValue 이벤트가 한 번 트리거 된 다음 데이터가 변경 될 때마다 다시 트리거됩니다. 콜백으로 전달 된 DataSnapshot on() 호출되는 위치를위한 것입니다. 전체 내용이 동기화 될 때까지 트리거되지 않습니다. 위치에 데이터가없는 경우 빈 DataSnapshot ( val() 이 null 반환하여 트리거됩니다. ).

서명:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, options: ListenOptions): Unsubscribe;

매개변수

보고:

구독 취소

리스너를 제거하기 위해 호출 할 수있는 함수.

OnValue (쿼리, 콜백, CancelCallback, 옵션)

특정 위치에서 데이터 변경에 대해서는 청취합니다.

이것은 데이터베이스에서 데이터를 읽는 주요 방법입니다. 초기 데이터와 데이터가 변경 될 때마다 콜백이 트리거됩니다. 반품되지 않은 구독 수신 콜백을 호출하여 업데이트 수신을 중지하십시오. 자세한 내용은 웹에서 데이터 검색을 참조하십시오.

이 위치에 저장된 초기 데이터를 사용하여 onValue 이벤트가 한 번 트리거 된 다음 데이터가 변경 될 때마다 다시 트리거됩니다. 콜백으로 전달 된 DataSnapshot on() 호출되는 위치를위한 것입니다. 전체 내용이 동기화 될 때까지 트리거되지 않습니다. 위치에 데이터가없는 경우 빈 DataSnapshot ( val() 이 null 반환하여 트리거됩니다. ).

서명:

export declare function onValue(query: Query, callback: (snapshot: DataSnapshot) => unknown, cancelCallback: (error: Error) => unknown, options: ListenOptions): Unsubscribe;

매개변수

보고:

구독 취소

리스너를 제거하기 위해 호출 할 수있는 함수.

쿼리 (Query, QueryConstraints)

추가 쿼리 제약 조건을 포함하도록 확장 된 새로운 불변의 Query 인스턴스를 만듭니다.

서명:

export declare function query(query: Query, ...queryConstraints: QueryConstraint[]): Query;

매개변수

보고:

질문

예외

if any of the provided query constraints cannot be combined with the existing or new constraints.

function(ref, ...)

onDisconnect(ref)

Returns an OnDisconnect object - see Enabling Offline Capabilities in JavaScript for more information on how to use it.

서명:

export declare function onDisconnect(ref: DatabaseReference): OnDisconnect;

매개변수

보고:

OnDisconnect

remove(ref)

Removes the data at this Database location.

Any data at child locations will also be deleted.

The effect of the remove will be visible immediately and the corresponding event 'value' will be triggered. Synchronization of the remove to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

서명:

export declare function remove(ref: DatabaseReference): Promise<void>;

매개변수

보고:

Promise<void>

Resolves when remove on server is complete.

runTransaction(ref, transactionUpdate, options)

Atomically modifies the data at this location.

Atomically modify the data at this location. Unlike a normal set() , which just overwrites the data regardless of its previous value, runTransaction() is used to modify the existing value to a new value, ensuring there are no conflicts with other clients writing to the same location at the same time.

To accomplish this, you pass runTransaction() an update function which is used to transform the current value into a new value. If another client writes to the location before your new value is successfully written, your update function will be called again with the new current value, and the write will be retried. This will happen repeatedly until your write succeeds without conflict or you abort the transaction by not returning a value from your update function.

서명:

export declare function runTransaction(ref: DatabaseReference, transactionUpdate: (currentData: any) => unknown, options?: TransactionOptions): Promise<TransactionResult>;

매개변수

보고:

Promise< TransactionResult >

A Promise that can optionally be used instead of the onComplete callback to handle success and failure.

set(ref, value)

Writes data to this Database location.

This will overwrite any data at this location and all child locations.

The effect of the write will be visible immediately, and the corresponding events ("value", "child_added", etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

Passing null for the new value is equivalent to calling remove() ; namely, all data at this location and all child locations will be deleted.

set() will remove any priority stored at this location, so if priority is meant to be preserved, you need to use setWithPriority() instead.

Note that modifying data with set() will cancel any pending transactions at that location, so extreme care should be taken if mixing set() and transaction() to modify the same data.

A single set() will generate a single "value" event at the location where the set() was performed.

서명:

export declare function set(ref: DatabaseReference, value: unknown): Promise<void>;

매개변수

보고:

Promise<void>

Resolves when write to server is complete.

setPriority(ref, priority)

Sets a priority for the data at this Database location.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

서명:

export declare function setPriority(ref: DatabaseReference, priority: string | number | null): Promise<void>;

매개변수

보고:

Promise<void>

Resolves when write to server is complete.

setWithPriority(ref, value, priority)

Writes data the Database location. Like set() but also specifies the priority for that data.

Applications need not use priority but can order collections by ordinary properties (see Sorting and filtering data ).

서명:

export declare function setWithPriority(ref: DatabaseReference, value: unknown, priority: string | number | null): Promise<void>;

매개변수

보고:

Promise<void>

Resolves when write to server is complete.

update(ref, values)

Writes multiple values to the Database at once.

The values argument contains multiple property-value pairs that will be written to the Database together. Each child property can either be a simple property (for example, "name") or a relative path (for example, "name/first") from the current location to the data to update.

As opposed to the set() method, update() can be use to selectively update only the referenced properties at the current location (instead of replacing all the child properties at the current location).

The effect of the write will be visible immediately, and the corresponding events ('value', 'child_added', etc.) will be triggered. Synchronization of the data to the Firebase servers will also be started, and the returned Promise will resolve when complete. If provided, the onComplete callback will be called asynchronously after synchronization has finished.

A single update() will generate a single "value" event at the location where the update() was performed, regardless of how many children were modified.

Note that modifying data with update() will cancel any pending transactions at that location, so extreme care should be taken if mixing update() and transaction() to modify the same data.

Passing null to update() will remove the data at this location.

See Introducing multi-location updates and more .

서명:

export declare function update(ref: DatabaseReference, values: object): Promise<void>;

매개변수

보고:

Promise<void>

Resolves when update on server is complete.

function(value, ...)

endAt(value, key)

Creates a QueryConstraint with the specified ending point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name less than or equal to the specified key.

You can read more about endAt() in Filtering data .

서명:

export declare function endAt(value: number | string | boolean | null, key?: string): QueryConstraint;

매개변수

보고:

QueryConstraint

endBefore(value, key)

Creates a QueryConstraint with the specified ending point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The ending point is exclusive. If only a value is provided, children with a value less than the specified value will be included in the query. If a key is specified, then children must have a value less than or equal to the specified value and a key name less than the specified key.

서명:

export declare function endBefore(value: number | string | boolean | null, key?: string): QueryConstraint;

매개변수

보고:

QueryConstraint

equalTo(value, key)

Creates a QueryConstraint that includes children that match the specified value.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have exactly the specified key as their key name. This can be used to filter result sets with many matches for the same value.

You can read more about equalTo() in Filtering data .

서명:

export declare function equalTo(value: number | string | boolean | null, key?: string): QueryConstraint;

매개변수

보고:

QueryConstraint

startAfter(value, key)

Creates a QueryConstraint with the specified starting point (exclusive).

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is exclusive. If only a value is provided, children with a value greater than the specified value will be included in the query. If a key is specified, then children must have a value greater than or equal to the specified value and aa key name greater than the specified key.

서명:

export declare function startAfter(value: number | string | boolean | null, key?: string): QueryConstraint;

매개변수

보고:

QueryConstraint

startAt(value, key)

Creates a QueryConstraint with the specified starting point.

Using startAt() , startAfter() , endBefore() , endAt() and equalTo() allows you to choose arbitrary starting and ending points for your queries.

The starting point is inclusive, so children with exactly the specified value will be included in the query. The optional key argument can be used to further limit the range of the query. If it is specified, then children that have exactly the specified value must also have a key name greater than or equal to the specified key.

You can read more about startAt() in Filtering data .

서명:

export declare function startAt(value?: number | string | boolean | null, key?: string): QueryConstraint;

매개변수

보고:

QueryConstraint

EventType

One of the following strings: "value", "child_added", "child_changed", "child_removed", or "child_moved."

서명:

export declare type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';

QueryConstraintType

Describes the different query constraints available in this SDK.

서명:

export declare type QueryConstraintType = 'endAt' | 'endBefore' | 'startAt' | 'startAfter' | 'limitToFirst' | 'limitToLast' | 'orderByChild' | 'orderByKey' | 'orderByPriority' | 'orderByValue' | 'equalTo';

구독 취소

A callback that can invoked to remove a listener.

서명:

export declare type Unsubscribe = () => void;