Interface CollectionsQueryParams

interface CollectionsQueryParams {
    limit?: number;
    path?: string;
    sort?: {
        direction?: SortDirection;
        propertyPath: "name" | "_id";
    };
}

Properties

limit? path? sort?

Properties

Optional limit

limit?: number

An optional number to limit the results of the collections query. If you omit this value, the query will return all values

Optional path

path?: string

The path of the Ditto string. If you omit this, it will fetch the first registered Ditto value.

Optional sort

sort?: {
    direction?: SortDirection;
    propertyPath: "name" | "_id";
}

Type declaration

  • Optional direction?: SortDirection
  • propertyPath: "name" | "_id"

    An optional sort parameter for your collections query. Allows sorting collections using the _id and names fields, in ascending or descending order:

    {
      propertyPath: "name",
      direction: "ascending"
    }

    For descending values use:

    {
      propertyPath: "name",
      direction: "descending"
    }

    For more information on the query string syntax refer to https://docs.ditto.live/concepts/querying

Settings

Member Visibility

Theme

On This Page

limitpathsort