@firebase/firestore/lite

기능

클래스

인터페이스

유형 별칭

기능(앱, ...)

getFirestore(앱)

제공된 FirebaseApp 과 연결된 기존 기본 Firestore 인스턴스를 반환합니다. . 인스턴스가 없으면 기본 설정으로 새 인스턴스를 초기화합니다.

서명:

export declare function getFirestore(app: FirebaseApp): Firestore;

매개변수

보고:

소방서

제공된 앱의 Firestore 인스턴스입니다.

getFirestore(앱, 데이터베이스 ID)

이 API는 개발자를 위한 미리 보기로 제공되며 받은 피드백에 따라 변경될 수 있습니다. 프로덕션 환경에서는 이 API를 사용하지 마십시오.

제공된 FirebaseApp 과 연결된 기존 Firestore 인스턴스를 반환합니다. . 인스턴스가 없으면 기본 설정으로 새 인스턴스를 초기화합니다.

서명:

export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;

매개변수

보고:

소방서

제공된 앱의 Firestore 인스턴스입니다.

초기화Firestore(앱, 설정)

제공된 설정을 사용하여 Cloud Firestore의 새 인스턴스를 초기화합니다. getFirestore() 를 포함한 다른 함수보다 먼저 호출될 수 있습니다. . 사용자 정의 설정이 비어 있는 경우 이 함수는 getFirestore()를 호출하는 것과 동일합니다. .

서명:

export declare function initializeFirestore(app: FirebaseApp, settings: Settings): Firestore;

매개변수

보고:

소방서

새로 초기화된 Firestore 인스턴스입니다.

초기화Firestore(앱, 설정, 데이터베이스Id)

이 API는 개발자를 위한 미리 보기로 제공되며 받은 피드백에 따라 변경될 수 있습니다. 프로덕션 환경에서는 이 API를 사용하지 마십시오.

제공된 설정을 사용하여 Cloud Firestore의 새 인스턴스를 초기화합니다. getFirestore() 를 포함한 다른 함수보다 먼저 호출될 수 있습니다. . 사용자 정의 설정이 비어 있는 경우 이 함수는 getFirestore()를 호출하는 것과 동일합니다. .

서명:

export declare function initializeFirestore(app: FirebaseApp, settings: Settings, databaseId?: string): Firestore;

매개변수

보고:

소방서

새로 초기화된 Firestore 인스턴스입니다.

함수(firestore, ...)

컬렉션(firestore, 경로, pathSegments)

지정된 절대 경로에 있는 컬렉션을 참조하는 CollectionReference 인스턴스를 가져옵니다.

서명:

export declare function collection(firestore: Firestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

매개변수

보고:

컬렉션참조 < 문서데이터 , 문서데이터 >

CollectionReference 인스턴스입니다.

예외

최종 경로에 짝수 개의 세그먼트가 있고 컬렉션을 가리키지 않는 경우.

collectionGroup(firestore, collectionId)

지정된 collectionId 가진 컬렉션 또는 하위 컬렉션에 포함된 데이터베이스의 모든 문서를 포함하는 새 Query 인스턴스를 생성하고 반환합니다. .

서명:

export declare function collectionGroup(firestore: Firestore, collectionId: string): Query<DocumentData, DocumentData>;

매개변수

보고:

질문 < 문서데이터 , 문서데이터 >

생성된 Query .

connectFirestoreEmulator(firestore, 호스트, 포트, 옵션)

Cloud Firestore 에뮬레이터와 통신하도록 이 인스턴스를 수정하세요.

서명:

export declare function connectFirestoreEmulator(firestore: Firestore, host: string, port: number, options?: {
    mockUserToken?: EmulatorMockTokenOptions | string;
}): void;

매개변수

보고:

무효의

DOC (Firestore, Path, Pathsegments)

지정된 절대 경로에서 문서를 나타내는 DocumentReference 인스턴스를 가져옵니다.

서명:

export declare function doc(firestore: Firestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

매개변수

보고:

문서참조 < documentData , DocumentData >

DocumentReference 인스턴스.

예외

최종 경로에 홀수 세그먼트가 있고 문서를 가리키지 않는 경우.

Runtransaction (Firestore, UpdateFunction, 옵션)

주어진 updateFunction 실행 한 다음 트랜잭션 내에 적용된 변경 사항을 커밋하려고 시도합니다. updateFunction 내에서 읽은 문서가 변경되면 Cloud Firestore . 5 번의 시도 후 커밋되지 않으면 거래가 실패합니다.

단일 거래에서 허용되는 최대 쓰기 수는 500입니다.

서명:

export declare function runTransaction<T>(firestore: Firestore, updateFunction: (transaction: Transaction) => Promise<T>, options?: TransactionOptions): Promise<T>;

매개변수

보고:

약속 <t>

트랜잭션이 성공적으로 완료되었거나 명시 적으로 중단 된 경우 ( updateFunction 실패한 약속을 반환) updateFunction 에 의해 반환 된 약속 여기에 반환됩니다. 그렇지 않으면 거래에 실패하면 해당 실패 오류에 대한 거부 된 약속이 반환됩니다.

종료 (Firestore)

제공된 Firestore 인스턴스를 종료합니다.

terminate() 호출 후 clearIndexedDbPersistence() 함수 만 사용될 수 있습니다. 다른 기능은 FirestoreError 던집니다 . 종료는 보류중인 글을 취소하지 않으며 서버에서 응답을 기다리는 약속은 해결되지 않습니다.

종료 후 다시 시작하려면 getFirestore () 를 사용하여 새로운 Firestore 인스턴스를 만듭니다. .

서명:

export declare function terminate(firestore: Firestore): Promise<void>;

매개변수

보고:

약속<공허>

인스턴스가 성공적으로 종료되었을 때 해결되는 Promise .

WriteBatch (Firestore)

단일 원자 연산으로 다중 쓰기를 수행하는 데 사용되는 쓰기 배치를 만듭니다. 단일 쓰기 배치에서 허용되는 최대 쓰기 수는 500입니다.

이 글의 결과는 반환 된 약속이 해결 된 후 발생하는 문서 읽기에만 반영됩니다. 클라이언트가 오프라인 상태 인 경우 쓰기가 실패합니다. 클라이언트가 온라인이 될 때까지 로컬 수정 또는 버퍼가 쓰기를보고 싶다면 Firestore SDK를 사용하십시오.

서명:

export declare function writeBatch(firestore: Firestore): WriteBatch;

매개변수

보고:

쓰기 배치

다중 쓰기를 원자 적으로 실행하는 데 사용할 수있는 WriteBatch .

기능()

세다()

쿼리 결과 세트에서 문서 수를 계산하는 데 사용할 수있는 AggregateField 객체를 만듭니다.

서명:

export declare function count(): AggregateField<number>;

보고:

골재 필드 <번호>

deletefield ()

{merge: true} 필드를 표시하려면 updateoc () 또는 setDoc () 와 함께 사용할 수있는 센티넬을 반환합니다.

서명:

export declare function deleteField(): FieldValue;

보고:

FieldValue

DocumentID ()

문서의 ID를 참조하기 위해 특별한 센티넬 FieldPath 반환합니다. 문서 ID로 정렬하거나 필터링하는 데 쿼리로 사용할 수 있습니다.

서명:

export declare function documentId(): FieldPath;

보고:

필드 경로

getfirestore ()

기본 FireBaseapp 와 관련된 기존 기본 Firestore 인스턴스를 반환합니다. . 인스턴스가없는 경우 기본 설정으로 새 인스턴스를 초기화합니다.

서명:

export declare function getFirestore(): Firestore;

보고:

Firestore

제공된 앱의 Firestore 인스턴스.

서버타임스탬프()

서면 데이터에 서버 생성 타임 스탬프를 포함시키기 위해 setDoc () 또는 updatedoc () 와 함께 사용 된 센티넬을 반환합니다.

서명:

export declare function serverTimestamp(): FieldValue;

보고:

FieldValue

기능 (Databaseid, ...)

GetFirestore (DatabaseId)

이 API는 개발자를위한 미리보기로 제공되며 우리가받는 피드백에 따라 변경 될 수 있습니다. 생산 환경 에서이 API를 사용하지 마십시오.

기본 FireBaseapp 와 관련된 기존 Firestore 인스턴스를 반환합니다. . 인스턴스가없는 경우 기본 설정으로 새 인스턴스를 초기화합니다.

서명:

export declare function getFirestore(databaseId: string): Firestore;

매개변수

보고:

Firestore

제공된 앱의 Firestore 인스턴스.

함수 (요소, ...)

Arrayremove (요소)

setDoc () 와 함께 사용할 수있는 특수 값을 반환하거나 서버에 서버에 이미 존재하는 배열 값에서 주어진 요소를 제거하도록 지시합니다. 지정된 각 요소의 모든 인스턴스는 배열에서 제거됩니다. 수정중인 필드가 아직 배열이 아닌 경우 빈 배열로 덮어 씁니다.

서명:

export declare function arrayRemove(...elements: unknown[]): FieldValue;

매개변수

보고:

FieldValue

setDoc() 또는 updateDoc() 에 대한 호출에 사용하기위한 FieldValue Sentinel

배열 (요소)

SetDoc () 또는 updatedoc () 와 함께 사용할 수있는 특수 값을 반환하여 서버에 서버에 이미 존재하는 배열 값으로 주어진 요소를 유니너로 알려줍니다. 배열에 아직 존재하지 않는 지정된 요소는 끝에 추가됩니다. 수정중인 필드가 아직 배열이 아닌 경우 지정된 요소가 포함 된 배열로 덮어 씁니다.

서명:

export declare function arrayUnion(...elements: unknown[]): FieldValue;

매개변수

보고:

FieldValue

setDoc() 또는 updateDoc() 에 대한 호출에 사용하기위한 FieldValue Sentinel .

기능 (필드, ...)

평균 (필드)

쿼리의 결과 세트에서 다양한 문서를 통해 지정된 필드의 평균을 계산하는 데 사용할 수있는 AggregateField 객체를 만듭니다.

서명:

export declare function average(field: string | FieldPath): AggregateField<number | null>;

매개변수

보고:

골재 필드 <번호 | null>

합 (필드)

쿼리의 결과 세트에서 다양한 문서를 통해 지정된 필드의 합을 계산하는 데 사용할 수있는 AggregateField 객체를 만듭니다.

서명:

export declare function sum(field: string | FieldPath): AggregateField<number>;

매개변수

보고:

골재 필드 <번호>

기능 (FieldPath, ...)

Orderby (FieldPath, Directionstr)

지정된 필드별로 쿼리 결과를 정렬하는 QueryOrderByConstraint 를 생성합니다.

서명:

export declare function orderBy(fieldPath: string | FieldPath, directionStr?: OrderByDirection): QueryOrderByConstraint;

매개변수

보고:

QueryOrderByConstraint

생성 된 QueryOrderByConstraint .

여기서 (FieldPath, opstr, value)

문서에 지정된 필드가 포함되어야하고 값이 제공된 관계 제약 조건을 충족 해야하는 QueryFieldFilterConstraint 를 만듭니다.

서명:

export declare function where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: unknown): QueryFieldFilterConstraint;

매개변수

보고:

QueryfieldFilterConstraint

생성 된 QueryfieldFilterConstraint .

함수 (FieldValues, ...)

endat (fieldValues)

쿼리 순서와 관련하여 제공된 필드에서 종료하도록 결과 세트를 수정하는 QueryEndAtConstraint 를 만듭니다. 필드 값의 순서는 쿼리의 조항에 의한 순서 순서와 일치해야합니다.

서명:

export declare function endAt(...fieldValues: unknown[]): QueryEndAtConstraint;

매개변수

보고:

QueryEndatConstraint

query() 로 전달할 queryendatconstraint

Endbefore (FieldValues)

쿼리 순서와 관련하여 제공된 필드 전에 종료하기 위해 결과 세트를 수정하는 QueryEndAtConstraint 를 만듭니다. 필드 값의 순서는 쿼리의 조항에 의한 순서 순서와 일치해야합니다.

서명:

export declare function endBefore(...fieldValues: unknown[]): QueryEndAtConstraint;

매개변수

보고:

QueryEndatConstraint

query() 로 전달할 queryendatconstraint

StartAfter (FieldValues)

쿼리 순서와 관련하여 제공된 필드 이후에 시작하도록 결과 세트를 수정하는 QueryStartAtConstraint 를 만듭니다. 필드 값의 순서는 쿼리의 조항에 의한 순서 순서와 일치해야합니다.

서명:

export declare function startAfter(...fieldValues: unknown[]): QueryStartAtConstraint;

매개변수

보고:

QueryStartAtConstraint

query() 로 전달할 querystartatconstraint

startat (fieldValues)

쿼리 순서와 관련하여 제공된 필드에서 시작하도록 결과 세트를 수정하는 QueryStartAtConstraint 를 만듭니다. 필드 값의 순서는 쿼리의 조항에 의한 순서 순서와 일치해야합니다.

서명:

export declare function startAt(...fieldValues: unknown[]): QueryStartAtConstraint;

매개변수

보고:

QueryStartAtConstraint

query() 로 전달할 querystartatconstraint .

기능 (왼쪽, ...)

Aggregatefieldequal (왼쪽, 오른쪽)

두 개의 'Aggregatefield를 비교합니다 `평등 사례.

서명:

export declare function aggregateFieldEqual(left: AggregateField<unknown>, right: AggregateField<unknown>): boolean;

매개변수

보고:

부울

AggregateQuerySnapShotequal (왼쪽, 오른쪽)

평등을 위해 두 개의 AggregateQuerySnapshot 인스턴스를 비교합니다.

두 개의 AggregateQuerySnapshot 인스턴스는 동일하고 동일한 데이터를 비교하는 기본 쿼리가있는 경우 "동일"으로 간주됩니다.

서명:

export declare function aggregateQuerySnapshotEqual<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(left: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>, right: AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>): boolean;

매개변수

보고:

부울

객체가 위에서 정의 된대로 "동일"하거나 그렇지 않으면 false 인 경우 true .

queryequal (왼쪽, 오른쪽)

제공된 쿼리가 동일한 컬렉션을 가리키고 동일한 제약 조건을 적용하면 TRUE를 반환합니다.

서명:

export declare function queryEqual<AppModelType, DbModelType extends DocumentData>(left: Query<AppModelType, DbModelType>, right: Query<AppModelType, DbModelType>): boolean;

매개변수

보고:

부울

참조가 동일한 Firestore 데이터베이스에서 동일한 위치를 가리키면 True.

refequal (왼쪽, 오른쪽)

제공된 참조가 같으면 true를 반환합니다.

서명:

export declare function refEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>, right: DocumentReference<AppModelType, DbModelType> | CollectionReference<AppModelType, DbModelType>): boolean;

매개변수

보고:

부울

참조가 동일한 Firestore 데이터베이스에서 동일한 위치를 가리키면 True.

Snapshotequal (왼쪽, 오른쪽)

제공된 스냅 샷이 같으면 true를 반환합니다.

서명:

export declare function snapshotEqual<AppModelType, DbModelType extends DocumentData>(left: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>, right: DocumentSnapshot<AppModelType, DbModelType> | QuerySnapshot<AppModelType, DbModelType>): boolean;

매개변수

보고:

부울

스냅 샷이 같으면 사실입니다.

함수(한계, ...)

한계 (한도)

첫 번째 일치하는 문서 만 반환하는 QueryLimitConstraint 를 만듭니다.

서명:

export declare function limit(limit: number): QueryLimitConstraint;

매개변수

보고:

QueryLimitConstraint

생성 된 QueryLimitConstraint .

LimitToLast(한계)

마지막 일치하는 문서 만 반환하는 QueryLimitConstraint 를 만듭니다.

limitToLast 쿼리에 대해 최소한 하나 orderBy 절을 지정해야합니다. 그렇지 않으면 실행 중에 예외가 발생됩니다.

서명:

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

매개변수

보고:

QueryLimitConstraint

생성 된 QueryLimitConstraint .

함수 (로그 레벨, ...)

setloglevel (loglevel)

클라우드 파이어 스토어 로그 (디버그, 오류 또는 무음)의 진실성을 설정합니다.

서명:

export declare function setLogLevel(logLevel: LogLevel): void;

매개변수

보고:

무효의

함수 (n, ...)

증분 (N)

SetDoc () 또는 updatedoc () 와 함께 사용할 수있는 특수 값을 반환하여 서버가 주어진 값으로 필드의 현재 값을 증분하도록 지시합니다.

피연산자 또는 현재 필드 값이 플로팅 포인트 정밀도를 사용하는 경우, 모든 산술은 IEEE 754 시맨틱을 따릅니다. 두 값이 모두 정수 인 경우 JavaScript의 안전한 번호 범위 ( Number.MIN_SAFE_INTEGER to Number.MAX_SAFE_INTEGER )도 정밀 손실을받습니다. 또한, Firestore 백엔드에 의해 처리되면, 모든 정수 작업은 -2^63에서 2^63-1 사이에서 캡핑됩니다.

현재 필드 값이 유형 number 가 아닌 경우 또는 필드가 아직 존재하지 않으면 변환은 필드를 주어진 값으로 설정합니다.

서명:

export declare function increment(n: number): FieldValue;

매개변수

보고:

FieldValue

setDoc() 또는 updateDoc() 에 대한 호출에 사용하기위한 FieldValue Sentinel

함수(쿼리, ...)

getAggregate (Query, AggregatesPec)

실제로 문서를 다운로드하지 않고 주어진 쿼리의 결과 집합에서 문서를 통해 지정된 집계를 계산합니다.

문서 데이터가 아닌 최종 집계 값 만 다운로드 되므로이 기능을 사용하여 집계를 수행하는 것이 효율적입니다. 이 기능은 결과 세트가 완전히 다운로드 할 수있는 (수천 개의 문서)가 엄청나게 큰 경우 문서의 집계를 수행 할 수 있습니다.

서명:

export declare function getAggregate<AggregateSpecType extends AggregateSpec, AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, aggregateSpec: AggregateSpecType): Promise<AggregateQuerySnapshot<AggregateSpecType, AppModelType, DbModelType>>;

매개변수

보고:

약속 < AggregateQuerySnapShot <AggregatesPectype, AppModelType, dbmodelType >>

예

const aggregateSnapshot = await getAggregate(query, {
  countOfDocs: count(),
  totalHours: sum('hours'),
  averageScore: average('score')
});

const countOfDocs: number = aggregateSnapshot.data().countOfDocs;
const totalHours: number = aggregateSnapshot.data().totalHours;
const averageScore: number | null = aggregateSnapshot.data().averageScore;

getCount (쿼리)

실제로 문서를 다운로드하지 않고 주어진 쿼리의 결과 집합에서 문서 수를 계산합니다.

문서 데이터가 아닌 최종 카운트 만 다운로드 되므로이 기능을 사용하여 문서를 계산하는 것이 효율적입니다. 이 기능은 결과 세트가 완전히 다운로드 할 수있는 경우 (수천 개의 문서) 문서를 계산할 수 있습니다.

서명:

export declare function getCount<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<AggregateQuerySnapshot<{
    count: AggregateField<number>;
}, AppModelType, DbModelType>>;

매개변수

보고:

약속 < AggregateQuerySnapShot <{count : Aggregatefield <번호>; }, AppModelType, dbmodelType >>

수로 해결 될 약속; 카운트는 snapshot.data().count 에서 검색 할 수 있습니다. 여기서 snapshot 반환 된 약속이 해결되는 AggregateQuerySnapshot 입니다.

getDocs (Query)

쿼리를 실행하고 결과를 querysnapshot 로 반환합니다. .

쿼리가 이전에 실행 된 경우에도 모든 쿼리는 서버에 의해 직접 실행됩니다. 최근 수정은 백엔드에 의해 이미 적용된 경우 검색된 결과에만 반영됩니다. 클라이언트가 오프라인 상태 인 경우 작업이 실패합니다. 이전에 캐시 된 결과 및 로컬 수정을 보려면 전체 Firestore SDK를 사용하십시오.

서명:

export declare function getDocs<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>): Promise<QuerySnapshot<AppModelType, DbModelType>>;

매개변수

보고:

약속 < QuerySnapShot <AppModelType, dbmodelType >>

쿼리 결과로 해결 될 약속.

쿼리 (쿼리, CompositeFilter, QueryConstraints)

추가 쿼리 제약 조건도 포함하도록 확장된 Query 의 변경할 수 없는 새 인스턴스를 만듭니다.

서명:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, compositeFilter: QueryCompositeFilterConstraint, ...queryConstraints: QueryNonFilterConstraint[]): Query<AppModelType, DbModelType>;

매개변수

보고:

질문 <AppModelType, DbModelType>

예외

제공된 쿼리 제약 조건을 기존 또는 새로운 제약 조건과 결합 할 수없는 경우.

쿼리(쿼리, 쿼리제약조건)

추가 쿼리 제약 조건도 포함하도록 확장된 Query 의 변경할 수 없는 새 인스턴스를 만듭니다.

서명:

export declare function query<AppModelType, DbModelType extends DocumentData>(query: Query<AppModelType, DbModelType>, ...queryConstraints: QueryConstraint[]): Query<AppModelType, DbModelType>;

매개변수

보고:

질문 <AppModelType, DbModelType>

예외

제공된 쿼리 제약 조건을 기존 또는 새로운 제약 조건과 결합 할 수없는 경우.

기능 (QueryConstraints, ...)

그리고 (QueryConstraints)

주어진 필터 제약 조건의 결합 인 새로운 querycompositeFilterConstraint를 만듭니다. 주어진 필터를 모두 만족시키는 경우 결합 필터에는 문서가 포함되어 있습니다.

서명:

export declare function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

매개변수

보고:

QueryCompositeFilterConstraint

새로 생성 된 querycompositeFilterConstraint .

또는 (QueryConstraints)

주어진 필터 제약 조건의 분리 인 새로운 querycompositeFilterConstraint를 만듭니다. 분리 필터에는 주어진 필터를 만족시키는 경우 문서가 포함되어 있습니다.

서명:

export declare function or(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

매개변수

보고:

QueryCompositeFilterConstraint

새로 생성 된 querycompositeFilterConstraint .

함수 (참조, ...)

AddDoc (참조, 데이터)

주어진 데이터와 지정된 CollectionReference 에 새 문서를 추가하여 자동으로 문서 ID를 할당하십시오.

이 글의 결과는 반환 된 약속이 해결 된 후 발생하는 문서 읽기에만 반영됩니다. 클라이언트가 오프라인 상태 인 경우 쓰기가 실패합니다. 클라이언트가 온라인이 될 때까지 로컬 수정 또는 버퍼가 쓰기를보고 싶다면 Firestore SDK를 사용하십시오.

서명:

export declare function addDoc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<DocumentReference<AppModelType, DbModelType>>;

매개변수

보고:

약속 < DocumentReference <AppModelType, dbmodelType >>

Promise 백엔드에 기록 된 후 새로 만든 문서를 가리키는 DocumentReference 로 해결되었습니다.

예외

오류 - 제공된 입력이 유효한 Firestore 문서가 아닌 경우.

컬렉션 (참조, 경로, 경로)

지정된 상대 경로에서 기준의 하위 reference 나타내는 CollectionReference 인스턴스를 가져옵니다.

서명:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

매개변수

보고:

CollectionReference < documentData , DocumentData >

CollectionReference 인스턴스.

예외

최종 경로에 균일 한 세그먼트가 있고 컬렉션을 가리키지 않는 경우.

컬렉션 (참조, 경로, 경로)

지정된 상대 경로에서 기준의 하위 reference 나타내는 CollectionReference 인스턴스를 가져옵니다.

서명:

export declare function collection<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>;

매개변수

보고:

CollectionReference < documentData , DocumentData >

CollectionReference 인스턴스.

예외

최종 경로에 균일 한 세그먼트가 있고 컬렉션을 가리키지 않는 경우.

deletedoc (참조)

지정된 DocumentReference 에서 언급 한 문서를 삭제합니다 .

삭제는 반환 된 약속이 해결 된 후 발생하는 문서 읽기에만 반영됩니다. 클라이언트가 오프라인 상태 인 경우 삭제가 실패합니다. 클라이언트가 온라인이 될 때까지 로컬 수정 또는 버퍼가 쓰기를보고 싶다면 Firestore SDK를 사용하십시오.

서명:

export declare function deleteDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<void>;

매개변수

보고:

약속<공허>

문서가 백엔드에서 성공적으로 삭제되면 Promise 해결되었습니다.

doc (참조, 경로, 경로)

지정된 상대 경로에서 reference 내 문서를 나타내는 DocumentReference 인스턴스를 가져옵니다. 경로가 지정되지 않으면 반환 된 DocumentReference 에 자동으로 생성 된 고유 ID가 사용됩니다. .

서명:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path?: string, ...pathSegments: string[]): DocumentReference<AppModelType, DbModelType>;

매개변수

보고:

문서참조 <AppModelType, DbModelType>

DocumentReference 인스턴스.

예외

최종 경로에 홀수 세그먼트가 있고 문서를 가리키지 않는 경우.

doc (참조, 경로, 경로)

지정된 상대 경로에서 reference 내 문서를 나타내는 DocumentReference 인스턴스를 가져옵니다.

서명:

export declare function doc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;

매개변수

보고:

문서참조 < documentData , DocumentData >

DocumentReference 인스턴스.

예외

최종 경로에 홀수 세그먼트가 있고 문서를 가리키지 않는 경우.

getdoc (참조)

지정된 문서 참조에서 언급 한 문서를 읽습니다.

문서가 이전에 읽거나 수정 된 경우에도 모든 문서는 서버에서 직접 가져옵니다. 최근 수정은 백엔드에서 이미 적용 된 경우 검색된 DocumentSnapshot 에만 반영됩니다. 클라이언트가 오프라인 상태 인 경우 읽기가 실패합니다. 캐싱을 사용하거나 로컬 수정을 보려면 전체 Firestore SDK를 사용하십시오.

서명:

export declare function getDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<DocumentSnapshot<AppModelType, DbModelType>>;

매개변수

보고:

약속 < dockumentsnapshot <AppModelType, dbmodelType >>

현재 문서 내용이 포함 된 DocumentSnapshot 으로 약속이 해결되었습니다.

setDoc (참조, 데이터)

지정된 DocumentReference 에서 언급 한 문서에 씁니다. . 문서가 아직 존재하지 않으면 생성됩니다.

이 글의 결과는 반환 된 약속이 해결 된 후 발생하는 문서 읽기에만 반영됩니다. 클라이언트가 오프라인 상태 인 경우 쓰기가 실패합니다. 클라이언트가 온라인이 될 때까지 로컬 수정 또는 버퍼가 쓰기를보고 싶다면 Firestore SDK를 사용하십시오.

서명:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: WithFieldValue<AppModelType>): Promise<void>;

매개변수

보고:

약속<공허>

데이터가 백엔드에 성공적으로 기록되면 Promise 해결되었습니다.

예외

오류 - 제공된 입력이 유효한 Firestore 문서가 아닌 경우.

setDoc (참조, 데이터, 옵션)

지정된 DocumentReference 에서 언급 한 문서에 씁니다. . 문서가 아직 존재하지 않으면 생성됩니다. merge 또는 mergeFields 제공하는 경우 제공된 데이터는 기존 문서로 병합 될 수 있습니다.

이 글의 결과는 반환 된 약속이 해결 된 후 발생하는 문서 읽기에만 반영됩니다. 클라이언트가 오프라인 상태 인 경우 쓰기가 실패합니다. 클라이언트가 온라인이 될 때까지 로컬 수정 또는 버퍼가 쓰기를보고 싶다면 Firestore SDK를 사용하십시오.

서명:

export declare function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): Promise<void>;

매개변수

보고:

약속<공허>

데이터가 백엔드에 성공적으로 기록되면 Promise 해결되었습니다.

예외

오류 - 제공된 입력이 유효한 Firestore 문서가 아닌 경우.

업데이트 (참조, 데이터)

지정된 DocumentReference 에서 언급 한 문서의 필드 업데이트 . 존재하지 않는 문서에 적용되면 업데이트가 실패합니다.

이 업데이트의 결과는 반환 된 약속이 해결 된 후 발생하는 문서 읽기에만 반영됩니다. 클라이언트가 오프라인 상태 인 경우 업데이트가 실패합니다. 클라이언트가 온라인이 될 때까지 로컬 수정 또는 버퍼가 쓰기를보고 싶다면 Firestore SDK를 사용하십시오.

서명:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: UpdateData<DbModelType>): Promise<void>;

매개변수

보고:

약속<공허>

데이터가 백엔드에 성공적으로 기록되면 Promise 해결되었습니다.

예외

오류 - 제공된 입력이 유효한 Firestore 데이터가 아닌 경우.

aludatedoc (참조, 필드, 가치, 더 많은 필드 밴드)

지정된 DocumentReference 에서 언급 한 문서의 업데이트 필드는 존재하지 않는 문서에 적용되면 업데이트가 실패합니다.

중첩 필드는 도트 분리 된 필드 경로 문자열을 제공하거나 FieldPath 객체를 제공하여 업데이트 할 수 있습니다.

이 업데이트의 결과는 반환 된 약속이 해결 된 후 발생하는 문서 읽기에만 반영됩니다. 클라이언트가 오프라인 상태 인 경우 업데이트가 실패합니다. 클라이언트가 온라인이 될 때까지 로컬 수정 또는 버퍼가 쓰기를보고 싶다면 Firestore SDK를 사용하십시오.

서명:

export declare function updateDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, field: string | FieldPath, value: unknown, ...moreFieldsAndValues: unknown[]): Promise<void>;

매개변수

보고:

약속<공허>

데이터가 백엔드에 성공적으로 기록되면 Promise 해결되었습니다.

예외

오류 - 제공된 입력이 유효한 Firestore 데이터가 아닌 경우.

함수 (스냅 샷, ...)

endat (스냅 샷)

제공된 문서 (포함)에서 종료하도록 결과 세트를 수정하는 QueryEndAtConstraint 를 만듭니다. 종료 위치는 쿼리 순서와 관련이 있습니다. 문서에는 쿼리의 순서로 제공된 모든 필드가 포함되어야합니다.

서명:

export declare function endAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

매개변수

보고:

QueryEndatConstraint

query() 로 전달할 queryendatconstraint

Endbefore (Snapshot)

제공된 문서 (독점) 전에 종료하도록 결과 세트를 수정하는 QueryEndAtConstraint 를 만듭니다. 종료 위치는 쿼리 순서와 관련이 있습니다. 문서에는 쿼리의 순서로 제공된 모든 필드가 포함되어야합니다.

서명:

export declare function endBefore<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;

매개변수

보고:

QueryEndatConstraint

query() 로 전달할 queryendatconstraint

StartAfter (Snapshot)

제공된 문서 (독점) 이후에 시작하도록 결과 세트를 수정하는 QueryStartAtConstraint 를 만듭니다. 시작 위치는 쿼리 순서와 관련이 있습니다. 문서에는 쿼리의 순서로 제공된 모든 필드가 포함되어야합니다.

서명:

export declare function startAfter<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

매개변수

보고:

QueryStartAtConstraint

query() 로 전달할 querystartatconstraint

startat (스냅 샷)

제공된 문서 (포함)에서 시작하도록 결과 세트를 수정하는 QueryStartAtConstraint 를 만듭니다. 시작 위치는 쿼리 순서와 관련이 있습니다. 문서에는이 쿼리의 orderBy 제공된 모든 필드가 포함되어야합니다.

서명:

export declare function startAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;

매개변수

보고:

QueryStartAtConstraint

query() 로 전달할 querystartatconstraint .

AddPrefixtokeys

모든 키가 점에 추가 된 외부 키로 접두사가있는 새 맵을 반환합니다.

서명:

export declare type AddPrefixToKeys<Prefix extends string, T extends Record<string, unknown>> = {
    [K in keyof T & string as `${Prefix}.${K}`]+?: string extends K ? any : T[K];
};

AggregateFieldType

Firestore가 지원하는 모든 AggregateField 유형의 결합.

서명:

export declare type AggregateFieldType = ReturnType<typeof sum> | ReturnType<typeof average> | ReturnType<typeof count>;

AggregatesPecData

키가 AggregateSpec 에서 가져온 유형 입력 AggregateSpec 에서 해당 AggregateField 에 의해 수행 된 응집의 결과는 값입니다. .

서명:

export declare type AggregateSpecData<T extends AggregateSpec> = {
    [P in keyof T]: T[P] extends AggregateField<infer U> ? U : never;
};

AGGREGATETYPE

수행 할 골재 유형을 나타내는 통합 유형.

서명:

export declare type AggregateType = 'count' | 'avg' | 'sum';

childupdatefields

주어진 유형 T1의 중첩 필드를 계산하기위한 도우미. 이것은 undefined | {...} (선택적 소품의 경우 발생) 또는 {a: A} | {b: B} .

이 사용 사례에서 V Record T[K] 의 노조 유형을 분배하는 데 사용됩니다. , T[K] 는 발현으로 평가되고 분포되지 않기 때문에.

https://www.typescriptlang.org/docs/handbook/advanced-types.html#distrive-conditional-types를 참조하십시오

서명:

export declare type ChildUpdateFields<K extends string, V> = V extends Record<string, unknown> ? AddPrefixToKeys<K, UpdateData<V>> : never;

FirestoreErrorCode

Firestore 상태 코드 세트. 코드는 grpc에 노출 된 코드와 동일합니다.

가능한 값 : - '취소': 작업이 취소되었습니다 (일반적으로 발신자가). - '알 수없는': 알려지지 않은 오류 또는 다른 오류 도메인의 오류. - '유효하지 않은 연계': 클라이언트는 잘못된 인수를 지정했습니다. 이는 '실패한 정화'와 다릅니다. '유효하지 않음'은 시스템 상태에 관계없이 문제가되는 인수를 나타냅니다 (예 : 잘못된 필드 이름). - 'Deadline-Exceed': 작업이 완료되기 전에 마감일이 만료되었습니다. 시스템 상태를 변경하는 작업의 경우 작업이 성공적으로 완료된 경우 에도이 오류가 반환 될 수 있습니다. 예를 들어, 서버의 성공적인 응답은 마감일이 만료 될 정도로 오래 지연 될 수 있습니다. - '전혀 발견되지 않았다': 일부 요청 된 문서는 찾을 수 없었습니다. - '이미 존재하는 것': 우리가 만들려고 시도한 일부 문서는 이미 존재합니다. - '허가 부인': 발신자는 지정된 작업을 실행할 권한이 없습니다. -'Resource-Exhausted': 일부 리소스가 소진되었으며, 아마도 사용자 당 할당량이 있거나 아마도 전체 파일 시스템이 공간 이외의 것일 수 있습니다. - '실패- 절도': 시스템이 작업 실행에 필요한 상태에 있지 않기 때문에 작동이 거부되었습니다. - '중단': 일반적으로 트랜잭션 중단 등과 같은 동시성 문제로 인해 작업이 중단되었습니다.- '범위 외': 작업은 유효한 범위를 지나서 시도되었습니다. - 'Unimplemented': 작동이 구현되지 않았거나 지원/활성화되지 않았습니다. - '내부': 내부 오류. 기본 시스템에서 예상되는 일부 불변량이 파손되었음을 의미합니다. 이러한 오류 중 하나가 보이면 무언가가 매우 깨졌습니다. - '사용할 수 없음': 현재 서비스를 사용할 수 없습니다. 이것은 아마도 일시적인 조건 일 가능성이 높으며 백 오프로 다시 시도하여 수정 될 수 있습니다. - 'Data-Loss': 복귀 할 수없는 데이터 손실 또는 손상. - 'Unuthenticated': 요청에는 작업에 대한 유효한 인증 자격 증명이 없습니다.

서명:

export declare type FirestoreErrorCode = 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';

NestEdupdatefields

각 필드 (예 : 'bar')마다 중첩 된 키를 모두 찾으십시오 (예 : { 'bar.baz': t1, 'bar.qux': t2 } ). 옵션으로 표시되는 모든 가능한 키를 포함하는 단일 맵을 만들기 위해 서로 교차합니다.

서명:

export declare type NestedUpdateFields<T extends Record<string, unknown>> = UnionToIntersection<{
    [K in keyof T & string]: ChildUpdateFields<K, T[K]>;
}[keyof T & string]>;

주문 방향

orderby () 절의 방향은 'desc'또는 'asc'(하강 또는 오름차순)로 지정됩니다.

서명:

export declare type OrderByDirection = 'desc' | 'asc';

부분적으로 fieldValue

TypeScript의 Partial<T> 와 유사합니다 , 그러나 중첩 된 필드를 생략하고 현장 가치를 속성 값으로 전달할 수 있습니다.

서명:

export declare type PartialWithFieldValue<T> = Partial<T> | (T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: PartialWithFieldValue<T[K]> | FieldValue;
} : never);

원어

원시 유형.

서명:

export declare type Primitive = string | number | boolean | undefined | null;

쿼리제약 유형

이 SDK에서 사용할 수 있는 다양한 쿼리 제약 조건을 설명합니다.

서명:

export declare type QueryConstraintType = 'where' | 'orderBy' | 'limit' | 'limitToLast' | 'startAt' | 'startAfter' | 'endAt' | 'endBefore';

QueryFilterConstraint

QueryFilterConstraint _ _ .

서명:

export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;

QueryNonFilterConstraint

QueryNonFilterConstraint 문서 세트를 좁히거나 주문하는 데 사용되는 QueryConstraints를 나타내는 도우미 노조 유형입니다. QueryNonFilterConstraint s는 Orderby를 호출하여 생성됩니다 () , 시작 위치() , 시작 후() , 종료전() , endat () , limit () 또는 limittoLast ()를 다음 QueryConstraint 포함하는 새 쿼리 인스턴스를 생성하기 위해 Query () 로 전달할 수 있습니다. .

서명:

export declare type QueryNonFilterConstraint = QueryOrderByConstraint | QueryLimitConstraint | QueryStartAtConstraint | QueryEndAtConstraint;

셋톱

setDoc () 의 동작을 구성하는 옵션 객체 및 전화. 이러한 통화는 merge: true 와 함께 SetOptions 제공하여 대상 문서를 전체적으로 덮어 쓰는 대신 과립 합병을 수행하도록 구성 할 수 있습니다. .

서명:

export declare type SetOptions = {
    readonly merge?: boolean;
} | {
    readonly mergeFields?: Array<string | FieldPath>;
};

Uniontointersection

Union Type U = T1 | T2 | ... , 교차 된 유형을 반환합니다 (T1 & T2 & ...) .

분배 조건부 유형 및 조건부 유형의 추론을 사용합니다. 이는 반영 변수 위치에서 동일한 유형 변수에 대한 여러 후보자가 교차 유형을 추론하기 때문에 작동합니다. https://www.typescriptlang.org/docs/handbook/advanced-types.html#tempe-inference-in-conditional-types https://stackoverflow.com/questions/50374908/transform-union-type-tintersection -유형

서명:

export declare type UnionToIntersection<U> = (U extends unknown ? (k: U) => void : never) extends (k: infer I) => void ? I : never;

업데이트

데이터 업데이트 ( 업데이트 와 함께 사용 )는 필드 경로 (예 : 'foo'또는 'foo.baz')로 구성됩니다. 도트를 포함하는 필드는 문서 내에서 중첩 된 필드를 참조합니다. FieldValues는 속성 값으로 전달할 수 있습니다.

서명:

export declare type UpdateData<T> = T extends Primitive ? T : T extends {} ? {
    [K in keyof T]?: UpdateData<T[K]> | FieldValue;
} & NestedUpdateFields<T> : Partial<T>;

Wherefilterop

Where () 조항의 필터 조건은 문자열 '& lt;', '& lt; =', '= =', '! =', '& gt; =', '& gt;', 'Array-Contains'를 사용하여 지정됩니다. , 'in', 'array-contains-any'및 'not-in'.

서명:

export declare type WhereFilterOp = '<' | '<=' | '==' | '!=' | '>=' | '>' | 'array-contains' | 'in' | 'array-contains-any' | 'not-in';

WithfieldValue

유형 안전을 유지하면서 FieldValues를 속성 값으로 전달할 수 있습니다.

서명:

export declare type WithFieldValue<T> = T | (T extends Primitive ? T : T extends {} ? {
    [K in keyof T]: WithFieldValue<T[K]> | FieldValue;
} : never);