add comments and make AttachmentTable options optional

powersync-ja · Oct 31, 2023 · 6e874c1 · 6e874c1
1 parent 025088a
commit 6e874c1
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/packages/powersync-attachments/src/AbstractAttachmentQueue.ts b/packages/powersync-attachments/src/AbstractAttachmentQueue.ts
@@ -13,9 +13,18 @@ import {
 export interface AttachmentQueueOptions {
   powersync: AbstractPowerSyncDatabase;
   storage: StorageAdapter;
+  /**
+   * How often to check for new attachments to sync, in milliseconds. Set to 0 or undefined to disable.
+   */
   syncInterval?: number;
+  /**
+   * How many attachments to keep in the cache
+   */
   cacheLimit?: number;
   attachmentDirectoryName?: string;
+  /**
+   * Whether to mark the initial watched attachment IDs to be synced
+   */
   performInitialSync?: boolean;
 }
 

diff --git a/packages/powersync-attachments/src/definitions/Schema.ts b/packages/powersync-attachments/src/definitions/Schema.ts
@@ -25,13 +25,14 @@ export enum AttachmentState {
   ARCHIVED = 4, // Attachment has been orphaned, i.e. the associated record has been deleted
 }
 
-export interface AttachmentTableOptions extends Omit<TableOptions, "name"> {
+export interface AttachmentTableOptions
+  extends Omit<TableOptions, "name" | "columns"> {
   name?: string;
   additionalColumns?: Column[];
 }
 
 export class AttachmentTable extends Table {
-  constructor(options: AttachmentTableOptions) {
+  constructor(options?: AttachmentTableOptions) {
     super({
       ...options,
       name: options.name ?? ATTACHMENT_TABLE,