Interface DatasetItemIdsProvider<IdType>

A DatasetItemIdsProvider provides ids which are filled inside a dataset. The limit parameter defines the maximum allowed ids to return.

interface DatasetItemIdsProvider<IdType> ((opts) => Promise<{
    data?: Record<IdType, Readonly<Record<string, any>>>;
    hasMore?: boolean;
    ids: IdType[];
    total?: number;
}>)

Type Parameters

  • Parameters

    • opts: {
          limit: number;
      }
      • limit: number

    Returns Promise<{
        data?: Record<IdType, Readonly<Record<string, any>>>;
        hasMore?: boolean;
        ids: IdType[];
        total?: number;
    }>

    a promise with the ids as array. An optional total value, which defines the full amount available ids. An optional hasMore flag, which defines that there where more ids available. An data lookup, which carries the concrete items. If provided a store is not requested for extra data.

    Opts

    options to respect during id resolving. A limit of -1 means unlimited.

Generated using TypeDoc