Skip to content

Commit dbdb762

Browse files
committed
Cleanup docs
1 parent 6a1e02d commit dbdb762

16 files changed

+174
-400
lines changed

common/api-review/firestore.api.md

+18-24
Original file line numberDiff line numberDiff line change
@@ -375,15 +375,14 @@ export interface LoadBundleTaskProgress {
375375
export { LogLevel }
376376

377377
// @public
378-
export interface MemoryCacheSettings {
378+
export type MemoryCacheSettings = {
379379
garbageCollector?: MemoryGarbageCollector;
380-
}
380+
};
381381

382382
// @public
383-
export interface MemoryEagerGarbageCollector {
384-
// (undocumented)
383+
export type MemoryEagerGarbageCollector = {
385384
kind: 'memoryEager';
386-
}
385+
};
387386

388387
// @public
389388
export function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;
@@ -392,19 +391,17 @@ export function memoryEagerGarbageCollector(): MemoryEagerGarbageCollector;
392391
export type MemoryGarbageCollector = MemoryEagerGarbageCollector | MemoryLruGarbageCollector;
393392

394393
// @public
395-
export interface MemoryLocalCache {
396-
// (undocumented)
394+
export type MemoryLocalCache = {
397395
kind: 'memory';
398-
}
396+
};
399397

400398
// @public
401399
export function memoryLocalCache(settings?: MemoryCacheSettings): MemoryLocalCache;
402400

403401
// @public
404-
export interface MemoryLruGarbageCollector {
405-
// (undocumented)
402+
export type MemoryLruGarbageCollector = {
406403
kind: 'memoryLru';
407-
}
404+
};
408405

409406
// @public
410407
export function memoryLruGarbageCollector(settings?: {
@@ -494,42 +491,39 @@ export class PersistentCacheIndexManager {
494491
}
495492

496493
// @public
497-
export interface PersistentCacheSettings {
494+
export type PersistentCacheSettings = {
498495
cacheSizeBytes?: number;
499496
tabManager?: PersistentTabManager;
500-
}
497+
};
501498

502499
// @public
503-
export interface PersistentLocalCache {
504-
// (undocumented)
500+
export type PersistentLocalCache = {
505501
kind: 'persistent';
506-
}
502+
};
507503

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

511507
// @public
512-
export interface PersistentMultipleTabManager {
513-
// (undocumented)
508+
export type PersistentMultipleTabManager = {
514509
kind: 'PersistentMultipleTab';
515-
}
510+
};
516511

517512
// @public
518513
export function persistentMultipleTabManager(): PersistentMultipleTabManager;
519514

520515
// @public
521-
export interface PersistentSingleTabManager {
522-
// (undocumented)
516+
export type PersistentSingleTabManager = {
523517
kind: 'persistentSingleTab';
524-
}
518+
};
525519

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

529523
// @public
530-
export interface PersistentSingleTabManagerSettings {
524+
export type PersistentSingleTabManagerSettings = {
531525
forceOwnership?: boolean;
532-
}
526+
};
533527

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

docs-devsite/_toc.yaml

+6-18
Original file line numberDiff line numberDiff line change
@@ -245,28 +245,10 @@ toc:
245245
path: /docs/reference/js/firestore_.loadbundletask.md
246246
- title: LoadBundleTaskProgress
247247
path: /docs/reference/js/firestore_.loadbundletaskprogress.md
248-
- title: MemoryCacheSettings
249-
path: /docs/reference/js/firestore_.memorycachesettings.md
250-
- title: MemoryEagerGarbageCollector
251-
path: /docs/reference/js/firestore_.memoryeagergarbagecollector.md
252-
- title: MemoryLocalCache
253-
path: /docs/reference/js/firestore_.memorylocalcache.md
254-
- title: MemoryLruGarbageCollector
255-
path: /docs/reference/js/firestore_.memorylrugarbagecollector.md
256248
- title: PersistenceSettings
257249
path: /docs/reference/js/firestore_.persistencesettings.md
258250
- title: PersistentCacheIndexManager
259251
path: /docs/reference/js/firestore_.persistentcacheindexmanager.md
260-
- title: PersistentCacheSettings
261-
path: /docs/reference/js/firestore_.persistentcachesettings.md
262-
- title: PersistentLocalCache
263-
path: /docs/reference/js/firestore_.persistentlocalcache.md
264-
- title: PersistentMultipleTabManager
265-
path: /docs/reference/js/firestore_.persistentmultipletabmanager.md
266-
- title: PersistentSingleTabManager
267-
path: /docs/reference/js/firestore_.persistentsingletabmanager.md
268-
- title: PersistentSingleTabManagerSettings
269-
path: /docs/reference/js/firestore_.persistentsingletabmanagersettings.md
270252
- title: Query
271253
path: /docs/reference/js/firestore_.query.md
272254
- title: QueryCompositeFilterConstraint
@@ -482,6 +464,8 @@ toc:
482464
path: /docs/reference/js/vertexai.aioptions.md
483465
- title: ArraySchema
484466
path: /docs/reference/js/vertexai.arrayschema.md
467+
- title: Backend
468+
path: /docs/reference/js/vertexai.backend.md
485469
- title: BaseParams
486470
path: /docs/reference/js/vertexai.baseparams.md
487471
- title: BooleanSchema
@@ -540,6 +524,8 @@ toc:
540524
path: /docs/reference/js/vertexai.generativecontentblob.md
541525
- title: GenerativeModel
542526
path: /docs/reference/js/vertexai.generativemodel.md
527+
- title: GoogleAIBackend
528+
path: /docs/reference/js/vertexai.googleaibackend.md
543529
- title: GroundingAttribution
544530
path: /docs/reference/js/vertexai.groundingattribution.md
545531
- title: GroundingMetadata
@@ -606,6 +592,8 @@ toc:
606592
path: /docs/reference/js/vertexai.toolconfig.md
607593
- title: UsageMetadata
608594
path: /docs/reference/js/vertexai.usagemetadata.md
595+
- title: VertexAIBackend
596+
path: /docs/reference/js/vertexai.vertexaibackend.md
609597
- title: VertexAIOptions
610598
path: /docs/reference/js/vertexai.vertexaioptions.md
611599
- title: VideoMetadata

0 commit comments

Comments
 (0)