Skip to content

Main Navigation Docs

Appearance

Sidebar Navigation

Getting Started

Overview

Example Apps

Starting with the Template App

Primitive CLI

The Local-First Model

Understanding Documents

Working with Data

Other Services

Document Explorer

Browser-Based Test Harness

Deploying to Production

Primitive Stack Overview

Is Primitive Right for You?

Reference

primitive-app

Services

JsBaoClientService

js-bao-wss-client

Classes

AuthError

JsBaoClient

JsBaoError

Functions

createModelClass

defineModelSchema

generateULID

initializeClient

initJsBao

isJsBaoError

Interfaces

AnalyticsAutoEventsOptions

AnalyticsClient

AnalyticsEventInput

AuthStateEvent

BasicUserInfo

BlobUploadCompletedEvent

BlobUploadFailedEvent

BlobUploadProgressEvent

CacheFacade

ClaimApplyOptions

ClaimApplyResult

ConfirmApplyOptions

ConfirmApplyResult

DatabaseConfig

DocumentAccessResult

DocumentCreateCommitFailedEvent

DocumentEvent

DocumentInfo

DocumentInvitation

DocumentInvitationResponse

DocumentMetadataChangedEvent

DocumentPermissionEntry

ExecutePromptOptions

ExecutePromptResult

GeminiGenerateRawOptions

GeminiGenerateResult

GeminiMessage

GeminiModelSummary

GeminiPromptOptions

GeminiStructuredOutput

GetWorkflowStatusOptions

IntegrationCallRequest

IntegrationCallResponse

IntegrationsAPI

InvitationEvent

JsBaoClientOptions

JsBaoEvents

ListWorkflowRunsOptions

ListWorkflowRunsResult

LlmChatOptions

MeUpdatedEvent

MeUpdateFailedEvent

NetworkModeEvent

OfflineAuthEnabledEvent

OfflineAuthExpiringSoonEvent

OfflineAuthFailedEvent

OfflineAuthRenewedEvent

OfflineAuthUnlockedEvent

PaginatedResult

PaginationOptions

PendingCreateCommittedEvent

PendingCreateFailedEvent

PermissionEvent

PromptsAPI

ReasoningOptions

ReleaseApplyOptions

ReleaseApplyResult

SessionInfo

StartWorkflowOptions

StartWorkflowResult

StatusChangedEvent

StorageProvider

TerminateWorkflowOptions

UserProfile

WorkflowDefineOptions

WorkflowRun

WorkflowsAPI

WorkflowStartedEvent

WorkflowStatusEvent

WorkflowStatusResult

YjsPersistenceContext

YjsPersistenceProvider

Type Aliases

AuthCode

GeminiContentPart

GeminiGenerateOptions

GeminiRole

InferAttrs

JsBaoErrorCode

StorageConfig

TypedModelConstructor

YjsPersistenceFactory

js-bao

Classes

BaseModel

DatabaseEngine

DocumentClosedError

DocumentResolutionError

Logger

ModelRegistry

RecordNotFoundError

StringSet

UniqueConstraintViolationError

Functions

attachAndRegisterModel

attachSchemaToClass

autoRegisterModel

createModelClass

defineModelSchema

dumpYDocToPlain

Field

generateULID

initJsBao

Model

resetJsBao

summarizePlainYDoc

Interfaces

ConnectedDocument

DatabaseConfig

DocumentConnectionEvent

DocumentManager

DumpOptions

DumpSummary

DumpSummaryEntry

FieldOptions

InitJsBaoOptions

InitJsBaoResult

ModelOptions

PaginatedResult

PaginationOptions

QueryOptions

SaveOptions

Type Aliases

DocumentConnectionCallback

DocumentFilter

DocumentPermissionHint

InferAttrs

ModelConstructor

PlainYDoc

ProjectionSpec

QueryResult

On this page

js-bao / DumpOptions

Interface: DumpOptions

Properties

includeIndexes?

optional includeIndexes: boolean

Pager

Previous pageDocumentManager

Next pageDumpSummary