Add documentation for display.table getData function

interval · Oct 10, 2022 · e496e39 · e496e39
1 parent dd4b52f
commit e496e39
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 6 deletions.
diff --git a/src/ioSchema.ts b/src/ioSchema.ts
@@ -548,9 +548,9 @@ export const ioSchema = {
       isAsync: z.optional(z.boolean().default(false)),
     }),
     state: z.object({
-      queryTerm: z.string().nullish(),
-      sortColumn: z.string().nullish(),
-      sortDirection: z.enum(['asc', 'desc']).nullish(),
+      queryTerm: z.string().optional(),
+      sortColumn: z.string().optional(),
+      sortDirection: z.enum(['asc', 'desc']).optional(),
       offset: z.number().int().default(0),
       pageSize: z.number().int(),
     }),

diff --git a/src/utils/table.ts b/src/utils/table.ts
@@ -63,9 +63,9 @@ type RenderedTableRow = {
 }
 
 export type TableDataFetcher<Row extends z.infer<typeof tableRow>> = (props: {
-  queryTerm?: string | null
-  sortColumn?: string | null
-  sortDirection?: 'asc' | 'desc' | null
+  queryTerm?: string
+  sortColumn?: string
+  sortDirection?: 'asc' | 'desc'
   offset: number
   pageSize: number
 }) => Promise<{ data: Row[]; totalRecords?: number }>