Mayson Monorepo Documentation
    Preparing search index...

    Interface ApiSearchResult<T>

    A container for paginated lists of search results. The array of objects is on the .data property, and .has_more indicates whether there are additional objects beyond the end of this list. The .next_page field can be used to paginate forwards.

    Please note, ApiSearchResult is beta functionality and is subject to change/removal at any time.

    interface ApiSearchResult<T> {
        object: "search_result";
        data: T[];
        has_more: boolean;
        url: string;
        next_page: string;
        total_count?: number;
    }

    Type Parameters

    • T
    Index

    Properties

    object data has_more url next_page total_count?

    Properties

    object: "search_result"
    data: T[]
    has_more: boolean

    True if this list has another page of items after this one that can be fetched.

    url: string

    The URL where this list can be accessed.

    next_page

    next_page: string

    The page token to use to get the next page of results. If has_more is true, this will be set to a concrete string value.

    total_count?: number

    The total number of search results. Only present when expand request parameter contains total_count.

    Settings

    Member Visibility

    On This Page

    Properties