@b-jones-rfd/sp-rest-connect - v5.1.1
    Preparing search index...

    Interface GetListContentsOptions

    Options accepted by every action in addition to its own parameters.

    interface GetListContentsOptions {
        listName: string;
        params?: URLSearchParams;
        signal?: AbortSignal;
        timeout?: number;
    }

    Hierarchy (View Summary)

    Index
    listName params? signal? timeout?
    listName: string

    List display title, as shown in the SharePoint UI (not the URL segment).

    params?: URLSearchParams

    OData query options, e.g. new URLSearchParams({ $select: 'Id,Title', $filter: "Status eq 'Open'", $top: '200' }). Without $top SharePoint returns at most 100 items.

    signal?: AbortSignal

    Cancels the request. Abort yields a Failure with code ABORTED.

    connection.getListContents({ listName: 'Tasks', signal: AbortSignal.timeout(5000) })
    timeout?: number

    Socket inactivity timeout in milliseconds: the request fails with code TIMEOUT if no bytes arrive for this long. It is not a cap on total duration; use signal with AbortSignal.timeout() for that. Omit for no timeout.

    Settings
    Member Visibility

    On This Page
    Properties