IndexedDbPendingCommitStorage | @sheetwrite/core/browser

@sheetwrite/core/browserclass

Browser-only durable pending queue. Import it from @sheetwrite/core/browser; the package's root entrypoint never evaluates IndexedDB globals.

Package: @sheetwrite/core/browser
Source: packages/core/src/indexeddb.ts#L61

Members 6

constructor

constructor(options?: IndexedDbPendingCommitStorageOptionsinterface IndexedDbPendingCommitStorageOptions {
  databaseName?: string;
  storeName?: string;
}interface IndexedDbPendingCommitStorageOptions {
  databaseName?: string;
  storeName?: string;
}interface IndexedDbPendingCommitStorageOptions {
  databaseName?: string;
  storeName?: string;
}Database and store naming options for durable pending commits.API reference →);

close

close: () => void;

load

load: (documentId: string, options: PendingCommitLoadOptionsinterface PendingCommitLoadOptions {
  signal?: AbortSignal;
  maxRecords: number;
  maxOperations: number;
  maxBytes: number;
}interface PendingCommitLoadOptions {
  signal?: AbortSignal;
  maxRecords: number;
  maxOperations: number;
  maxBytes: number;
}interface PendingCommitLoadOptions {
  signal?: AbortSignal;
  maxRecords: number;
  maxOperations: number;
  maxBytes: number;
}Mandatory bounds for one durable pending-commit restore.API reference →) => Promise<readonly PendingCommitinterface PendingCommit {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  readonly operations: readonly DocumentOp[];
}interface PendingCommit {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  readonly operations: readonly DocumentOp[];
}interface PendingCommit {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  readonly operations: readonly DocumentOp[];
}Immutable local operation batch awaiting a host acknowledgement.API reference →[]>;

put

put: (commit: PendingCommitinterface PendingCommit {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  readonly operations: readonly DocumentOp[];
}interface PendingCommit {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  readonly operations: readonly DocumentOp[];
}interface PendingCommit {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  readonly operations: readonly DocumentOp[];
}Immutable local operation batch awaiting a host acknowledgement.API reference →, signal?: AbortSignal) => Promise<void>;

remove

remove: (documentId: string, clientMutationId: string, signal?: AbortSignal) => Promise<void>;

replace Atomically replaces one document queue only if its ordered IDs still match the caller's expected view.

replace: (documentId: string, expectedClientMutationIds: readonly string[], commits: readonly PendingCommitinterface PendingCommit {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  readonly operations: readonly DocumentOp[];
}interface PendingCommit {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  readonly operations: readonly DocumentOp[];
}interface PendingCommit {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  readonly operations: readonly DocumentOp[];
}Immutable local operation batch awaiting a host acknowledgement.API reference →[], signal?: AbortSignal) => Promise<void>

Declaration

View full TypeScript declaration

class IndexedDbPendingCommitStorage implements PendingCommitStorageinterface PendingCommitStorage {
  load(
    documentId: string,
    options: PendingCommitLoadOptions,
  ): Promise<readonly PendingCommit[]>;
  put(commit: PendingCommit, signal?: AbortSignal): Promise<void>;
  remove(
    documentId: string,
    clientMutationId: string,
    signal?: AbortSignal,
  ): Promise<void>;
  replace(
    documentId: string,
    expectedClientMutationIds: readonly string[],
    commits: readonly PendingCommit[],
  // … 3 more lines — see the API reference
}interface PendingCommitStorage {
  load(
    documentId: string,
    options: PendingCommitLoadOptions,
  ): Promise<readonly PendingCommit[]>;
  put(commit: PendingCommit, signal?: AbortSignal): Promise<void>;
  remove(
    documentId: string,
    clientMutationId: string,
    signal?: AbortSignal,
  ): Promise<void>;
  replace(
    documentId: string,
    expectedClientMutationIds: readonly string[],
    commits: readonly PendingCommit[],
  // … 3 more lines — see the API reference
}interface PendingCommitStorage {
  load(
    documentId: string,
    options: PendingCommitLoadOptions,
  ): Promise<
    readonly PendingCommit[]
  >;
  put(
    commit: PendingCommit,
    signal?: AbortSignal,
  ): Promise<void>;
  remove(
    documentId: string,
    clientMutationId: string,
    signal?: AbortSignal,
  ): Promise<void>;
  replace(
    documentId: string,
    expectedClientMutationIds: readonly string[],
  // … 4 more lines — see the API reference
}Host-owned durable queue. Browser storage lives in the optional ./browser entrypoint.API reference → {
  constructor(options?: IndexedDbPendingCommitStorageOptionsinterface IndexedDbPendingCommitStorageOptions {
  databaseName?: string;
  storeName?: string;
}interface IndexedDbPendingCommitStorageOptions {
  databaseName?: string;
  storeName?: string;
}interface IndexedDbPendingCommitStorageOptions {
  databaseName?: string;
  storeName?: string;
}Database and store naming options for durable pending commits.API reference →);
  close: () => void;
  load: (
    documentId: string,
    options: PendingCommitLoadOptionsinterface PendingCommitLoadOptions {
  signal?: AbortSignal;
  maxRecords: number;
  maxOperations: number;
  maxBytes: number;
}interface PendingCommitLoadOptions {
  signal?: AbortSignal;
  maxRecords: number;
  maxOperations: number;
  maxBytes: number;
}interface PendingCommitLoadOptions {
  signal?: AbortSignal;
  maxRecords: number;
  maxOperations: number;
  maxBytes: number;
}Mandatory bounds for one durable pending-commit restore.API reference →,
  ) => Promise<readonly PendingCommitinterface PendingCommit {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  readonly operations: readonly DocumentOp[];
}interface PendingCommit {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  readonly operations: readonly DocumentOp[];
}interface PendingCommit {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  readonly operations: readonly DocumentOp[];
}Immutable local operation batch awaiting a host acknowledgement.API reference →[]>;
  put: (commit: PendingCommitinterface PendingCommit {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  readonly operations: readonly DocumentOp[];
}interface PendingCommit {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  readonly operations: readonly DocumentOp[];
}interface PendingCommit {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  readonly operations: readonly DocumentOp[];
}Immutable local operation batch awaiting a host acknowledgement.API reference →, signal?: AbortSignal) => Promise<void>;
  remove: (
    documentId: string,
    clientMutationId: string,
    signal?: AbortSignal,
  ) => Promise<void>;
  replace: (
    documentId: string,
    expectedClientMutationIds: readonly string[],
    commits: readonly PendingCommitinterface PendingCommit {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  readonly operations: readonly DocumentOp[];
}interface PendingCommit {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  readonly operations: readonly DocumentOp[];
}interface PendingCommit {
  documentId: string;
  baseVersion: number;
  clientMutationId: string;
  readonly operations: readonly DocumentOp[];
}Immutable local operation batch awaiting a host acknowledgement.API reference →[],
    signal?: AbortSignal,
  ) => Promise<void>;
}