Skip to main content
Version: Next

CatalogClient.streamEntities()

Home > @backstage/catalog-client > CatalogClient > 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

StreamEntitiesRequest

(Optional) Request parameters

options

CatalogRequestOptions

(Optional) Additional options

**Returns:**

AsyncIterable<Entity[]>