Skip to main content

IncrementalEntityProvider.next()

Home > @backstage/plugin-catalog-backend-module-incremental-ingestion > IncrementalEntityProvider > next

Return a single page of entities from a specific point in the ingestion.

Signature:

next(context: TContext, cursor?: TCursor): Promise<EntityIteratorResult<TCursor>>;

Parameters

ParameterTypeDescription
contextTContextanything needed in order to fetch a single page.
cursorTCursor(Optional) a unique value identifying the page to ingest.

Returns:

Promise<EntityIteratorResult<TCursor>>

The entities to be ingested, as well as the cursor of the next page after this one.