Flarum (2.x)
    Preparing search index...

    Interface ApiQueryParamsPlural

    interface ApiQueryParamsPlural {
        fields?: string[];
        filter?: Record<string, any> | { q: string };
        include?: string;
        meta?: MetaInformation;
        page?: {
            limit?: number;
            near?: number;
            number?: number;
            offset?: number;
            size?: number;
            total?: number;
        };
        sort?: string;
        withDefaultIncludes?: boolean;
    }
    Index
    fields? filter? include? meta? page? sort? withDefaultIncludes?
    fields?: string[]
    filter?: Record<string, any> | { q: string }
    include?: string
    meta?: MetaInformation

    Optionalpage

    page?: {
        limit?: number;
        near?: number;
        number?: number;
        offset?: number;
        size?: number;
        total?: number;
    }

    Type Declaration

    • Optionallimit?: number
    • Optionalnear?: number
    • Optionalnumber?: number
    • Optionaloffset?: number
    • Optionalsize?: number
    • Optionaltotal?: number

      0 skips counting every match for meta.page.total.

    sort?: string
    withDefaultIncludes?: boolean

    Get the endpoint's default includes as well as those named in include.

    Settings
    Member Visibility

    On This Page
    Properties