Skip to content
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

New way to config Firestore SDK Cache. #7015

Merged
merged 25 commits into from
Mar 15, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Prev Previous commit
Rename indexeddb to persistent
  • Loading branch information
wu-hui committed Mar 13, 2023
commit e6b82501e5aca71908ce476ec5520717bde8eb57
84 changes: 42 additions & 42 deletions common/api-review/firestore.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ export class FirestoreError extends FirebaseError {
export 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';

// @public
export type FirestoreLocalCache = MemoryLocalCache | IndexedDbLocalCache;
export type FirestoreLocalCache = MemoryLocalCache | PersistentLocalCache;

// @public
export interface FirestoreSettings {
Expand Down Expand Up @@ -292,47 +292,6 @@ export interface IndexConfiguration {
readonly indexes?: Index[];
}

// @public
export interface IndexedDbCacheSettings {
cacheSizeBytes?: number;
tabManager?: IndexedDbTabManager;
}

// @public
export interface IndexedDbLocalCache {
// (undocumented)
kind: 'indexeddb';
}

// @public
export function indexedDbLocalCache(settings?: IndexedDbCacheSettings): IndexedDbLocalCache;

// @public
export interface IndexedDbMultipleTabManager {
// (undocumented)
kind: 'IndexedDbMultipleTab';
}

// @public
export function indexedDbMultipleTabManager(): IndexedDbMultipleTabManager;

// @public
export interface IndexedDbSingleTabManager {
// (undocumented)
kind: 'indexedDbSingleTab';
}

// @public
export function indexedDbSingleTabManager(settings: IndexedDbSingleTabManagerSettings | undefined): IndexedDbSingleTabManager;

// @public
export interface IndexedDbSingleTabManagerSettings {
forceOwnership?: boolean;
}

// @public
export type IndexedDbTabManager = IndexedDbSingleTabManager | IndexedDbMultipleTabManager;

// @beta
export interface IndexField {
// (undocumented)
Expand Down Expand Up @@ -458,6 +417,47 @@ export interface PersistenceSettings {
forceOwnership?: boolean;
}

// @public
export interface PersistentCacheSettings {
cacheSizeBytes?: number;
tabManager?: PersistentTabManager;
}

// @public
export interface PersistentLocalCache {
// (undocumented)
kind: 'persistent';
}

// @public
export function persistentLocalCache(settings?: PersistentCacheSettings): PersistentLocalCache;

// @public
export interface PersistentMultipleTabManager {
// (undocumented)
kind: 'PersistentMultipleTab';
}

// @public
export function persistentMultipleTabManager(): PersistentMultipleTabManager;

// @public
export interface PersistentSingleTabManager {
// (undocumented)
kind: 'persistentSingleTab';
}

// @public
export function persistentSingleTabManager(settings: PersistentSingleTabManagerSettings | undefined): PersistentSingleTabManager;

// @public
export interface PersistentSingleTabManagerSettings {
forceOwnership?: boolean;
}

// @public
export type PersistentTabManager = PersistentSingleTabManager | PersistentMultipleTabManager;

// @public
export type Primitive = string | number | boolean | undefined | null;

Expand Down
48 changes: 0 additions & 48 deletions docs-devsite/firestore_.indexeddbcachesettings.md

This file was deleted.

35 changes: 0 additions & 35 deletions docs-devsite/firestore_.indexeddbsingletabmanagersettings.md

This file was deleted.

Loading