Globus SDK for JavaScript
    Preparing search index...

    Type Alias Pagination

    Pagination used by the Transfer service.

    Each pagination definition contains a Query and Response type.

    • The Query type is used to define the query parameters used by the pagination method.
    • The Response type is used to define the response properties returned by the pagination method (usually as top-level keys in the response body).

    Service methods SHOULD include the supported pagination members in their query parameters and response types, these are just made available as a convenience.

    https://docs.globus.org/api/transfer/overview/#paging

    type Pagination = {
        LastKey: {
            Query: { last_key: string; limit?: `${number}` | number };
            Response: {
                has_next_page: `${boolean}` | boolean;
                last_key: string | null;
                limit: number;
            };
        };
        Marker: {
            Query: { marker?: `${number}`
            | number };
            Response: { next_marker: number | null };
        };
        NextToken: {
            Query: { max_results?: `${number}`
            | number; next_token?: string };
            Response: { next_token: string | null };
        };
        Offset: {
            Query: { limit?: `${number}`
            | number; offset?: `${number}` | number };
            Response: {
                has_next_page: `${boolean}` | boolean;
                limit: number;
                offset: number;
            };
        };
    }
    Index

    Properties

    LastKey Marker NextToken Offset

    Properties

    LastKey: {
        Query: { last_key: string; limit?: `${number}` | number };
        Response: {
            has_next_page: `${boolean}` | boolean;
            last_key: string | null;
            limit: number;
        };
    }

    https://docs.globus.org/api/transfer/overview/#last_key_paging

    Marker: {
        Query: { marker?: `${number}` | number };
        Response: { next_marker: number | null };
    }

    https://docs.globus.org/api/transfer/overview/#marker_paging

    NextToken: {
        Query: { max_results?: `${number}` | number; next_token?: string };
        Response: { next_token: string | null };
    }

    https://docs.globus.org/api/transfer/overview/#next_token_paging

    Offset: {
        Query: { limit?: `${number}` | number; offset?: `${number}` | number };
        Response: {
            has_next_page: `${boolean}` | boolean;
            limit: number;
            offset: number;
        };
    }

    https://docs.globus.org/api/transfer/overview/#offset_paging

    Settings

    Member Visibility

    On This Page

    Properties