Interface EntityQuery

interface EntityQuery {
    amount?: number;
    fields?: ("id" | "created_at" | "profile" | "updated_at" | (keyof EntityCreateInfo))[];
    filter?: RecursivePartial<EntityInfo>;
    orderBy?: ["name" | "created_at" | "updated_at", "desc" | "asc"];
    page?: number;
    resolveBucketName?: boolean;
    resolveConnectorName?: boolean;
}

Hierarchy (view full)

  • Query<EntityInfo, "name" | "visible" | "active" | "last_input" | "created_at" | "updated_at">
    • EntityQuery

Properties

amount? fields? filter? orderBy? page? resolveBucketName? resolveConnectorName?

Properties

Optional amount

amount?: number

Amount of items will return.

Optional fields

fields?: ("id" | "created_at" | "profile" | "updated_at" | (keyof EntityCreateInfo))[]

Array of field names.

Optional filter

filter?: RecursivePartial<EntityInfo>

Filter object.

Optional orderBy

orderBy?: ["name" | "created_at" | "updated_at", "desc" | "asc"]

Tuple with a field and an order

Optional page

page?: number

Page of list starting from 1

Optional resolveBucketName

resolveBucketName?: boolean

Optional resolveConnectorName

resolveConnectorName?: boolean

Settings

Member Visibility

Theme

On This Page

amountfieldsfilterorderBypageresolveBucketNameresolveConnectorName