CatalogApi.streamEntities()
Home > @backstage/catalog-client > CatalogApi > streamEntities
Asynchronously streams entities from the catalog. Uses queryEntities to fetch entities in batches, and yields them one page at a time.
Signature:
streamEntities(request?: StreamEntitiesRequest, options?: CatalogRequestOptions): AsyncIterable<Entity[]>;
Parameters
|
Parameter |
Type |
Description |
|---|---|---|
|
request |
(Optional) Request parameters | |
|
options |
(Optional) Additional options |
AsyncIterable<Entity[]>