shaligo
    Preparing search index...

    Interface ListResource<TSummary, TDetail, TParams>

    interface ListResource<TSummary, TDetail, TParams> {
        get: (id: number) => Promise<TDetail>;
        list: (params?: TParams) => Promise<Paginated<TSummary>>;
        listAll: (params?: TParams) => AsyncGenerator<TSummary>;
    }

    Type Parameters

    • TSummary
    • TDetail
    • TParams
    Index
    get list listAll
    get: (id: number) => Promise<TDetail>

    Fetch a single record by ID.

    list: (params?: TParams) => Promise<Paginated<TSummary>>

    Fetch a single page.

    listAll: (params?: TParams) => AsyncGenerator<TSummary>

    Iterate every result across all pages.

    Settings
    Member Visibility

    On This Page
    Properties