Skip to main content
Version: 1.0.0

Interface: CollectionFetchProps<M>

Type parameters

NameType
Mextends Object

Properties

entitiesDisplayedFirst

Optional entitiesDisplayedFirst: Entity<M>[]

List of entities that will be displayed on top, no matter the ordering. This is used for reference fields selection

Defined in

hooks/data/useCollectionFetch.tsx:29


filterValues

Optional filterValues: FilterValues<M>

Filter the fetched data by the property

Defined in

hooks/data/useCollectionFetch.tsx:34


itemCount

Optional itemCount: number

Number of entities to fetch

Defined in

hooks/data/useCollectionFetch.tsx:23


path

path: string

Absolute collection path

Defined in

hooks/data/useCollectionFetch.tsx:13


schemaResolver

schemaResolver: EntitySchemaResolver<M>

Schema of the entity displayed by this collection

Defined in

hooks/data/useCollectionFetch.tsx:18


searchString

Optional searchString: string

Search string

Defined in

hooks/data/useCollectionFetch.tsx:44


sortBy

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

Sort the results by

Defined in

hooks/data/useCollectionFetch.tsx:39

Enterprise or start-up?

Learn how to get the most out of your project with the help of our consulting team.
Learn more
Sign up to our newsletter to get the latest news and updates. No spam!