神岛 API 文档 - ArenaPro版
    Preparing search index...

    Type Alias ListPageOptions

    列表分页查询选项。

    Options for paginated list queries.

    type ListPageOptions = {
        ascending?: boolean;
        constraintTarget?: string;
        cursor: number;
        max?: number;
        min?: number;
        pageSize?: number;
    }
    Index

    Properties

    ascending? constraintTarget? cursor max? min? pageSize?

    Properties

    ascending?: boolean

    是否升序，设置为 true 时为升序，false 为降序，不传或传入 undefined 时不排序。

    Whether to sort in ascending order. Set to true for ascending, false for descending. If not provided or undefined, no sorting is applied.

    constraintTarget?: string

    约束目标值的路径，当值是 JSON 格式时，指定用作排序的值的路径。例如传入 score 时，会取值上 score 属性的值作为排序、最大最小值的限制目标。 可以级联最多5级，例如 a.b.c.d.e，超出视作非法参数。 当路径不存在或传入非法参数时，以值本身作为目标进行排序。

    The path to the constraint target value. When the value is in JSON format, this specifies the path to the value used for sorting. For example, passing score will use the value of the score property for sorting and for max/min constraints. It can be cascaded up to 5 levels, e.g., a.b.c.d.e. Exceeding this is an invalid parameter. If the path does not exist or an invalid parameter is passed, the value itself is used as the target for sorting.

    cursor: number

    分页指针，用于指定本次获取的分页起点。

    The cursor for pagination, used to specify the starting point for the current page.

    max?: number

    最大值，过滤返回对应值的最大值。默认不过滤。

    The maximum value, used to filter and return keys with values up to this maximum. No filtering by default.

    min?: number

    最小值，过滤返回对应值的最小值。默认不过滤。

    The minimum value, used to filter and return keys with values down to this minimum. No filtering by default.

    pageSize?: number

    分页大小，一页内的数据量，取值范围 [1, 100]，默认 10。

    The page size, representing the amount of data in one page. The value range is [1, 100], default is 10.

    Settings

    Member Visibility

    On This Page

    Properties