📆 Don't miss our Sanity Showcase virtual meetup on March 20th!
@public
interface

DocumentListOptions

Interface for document List options

Import

import {type DocumentListOptions} from 'sanity/structure'

Signature

interface DocumentListOptions {
  apiVersion?: string
  defaultOrdering?: SortOrderingItem[]
  filter: string
  params?: Record<string, unknown>
}

Properties

apiVersion?: string
apiVersion?: string

Document list API version

defaultOrdering?: SortOrderingItem[]
defaultOrdering?: SortOrderingItem[]

Document list API default ordering array.

filter: string
filter: string

Document list filter

params?: Record<string, unknown>
params?: Record<string, unknown>

Document list parameters

sanity@3.79.0