Skip to content
FireCMS Logo FireCMS

CollectionFetchProps

@firecms/core

@firecms/core / CollectionFetchProps

Interface: CollectionFetchProps<M>

Section titled “Interface: CollectionFetchProps<M>”

Defined in: hooks/data/useCollectionFetch.tsx:10

Type Parameters

Section titled “Type Parameters”

M

Section titled “M”

M extends Record<string, any>

Properties

Section titled “Properties”

collection

Section titled “collection”

collection: EntityCollection<M>

Defined in: hooks/data/useCollectionFetch.tsx:20

collection of the entity displayed by this collection

filterValues?

Section titled “filterValues?”

optional filterValues: Partial<Record<Extract<keyof M, string>, [WhereFilterOp, any]>>

Defined in: hooks/data/useCollectionFetch.tsx:30

Filter the fetched data by the property

itemCount?

Section titled “itemCount?”

optional itemCount: number

Defined in: hooks/data/useCollectionFetch.tsx:25

Number of entities to fetch

path

Section titled “path”

path: string

Defined in: hooks/data/useCollectionFetch.tsx:15

Absolute collection path

searchString?

Section titled “searchString?”

optional searchString: string

Defined in: hooks/data/useCollectionFetch.tsx:40

Search string

sortBy?

Section titled “sortBy?”

optional sortBy: [Extract<keyof M, string>, "desc" | "asc"]

Defined in: hooks/data/useCollectionFetch.tsx:35

Sort the results by