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

    Type Alias ListPageOptions

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

    Properties

    ascending?: boolean

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

    constraintTarget?: string
    • 约束目标值的路径,当值是JSON格式时,指定用作排序的值的路径。例如传入 score时,会取值上score属性的值作为排序、最大最小值的限制目标;
    • 可以级联最多5级,例如a.b.c.d.e,超出视作非法参数,按下一条方式处理;
    • 当路径不存在或传入非法参数时,以值本身作为目标进行排序,并打印一条警告;
    cursor: number

    分页指针,用于指定本次获取的分页起点页码。 第一页从0开始。展示第1项至第ListPageOptions.pageSize项数据。

    max?: number

    最大值,过滤返回对应值的最大值,超出或非数字则不返回该Key,默认不过滤;

    min?: number

    最小值,过滤返回对应值的最小值,超出或非数字则不返回该Key,默认不过滤;

    pageSize?: number

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