TagoIO SDK for JavaScript and TypeScript
    Preparing search index...

    Interface EntityQuery

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

    Hierarchy (View Summary)

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

    Properties

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

    Properties

    amount?: number

    Amount of items will return.

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

    Array of field names.

    filter?: RecursivePartial<EntityInfo>

    Filter object.

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

    Tuple with a field and an order

    Optionalpage

    page?: number

    Page of list starting from 1

    resolveBucketName?: boolean
    resolveConnectorName?: boolean

    Settings

    Member Visibility

    On This Page

    Properties