@promptbook/remote-client
Version:
Promptbook: Turn your company's scattered knowledge into AI ready books
25 lines (24 loc) • 1.39 kB
TypeScript
import type { PipelineJson } from '../../../pipeline/PipelineJson/PipelineJson';
import type { PipelineCollection } from '../PipelineCollection';
/**
* Constructs `PipelineCollection` from async sources
*
* It can be one of the following:
* - Promise of array of PipelineJson or PipelineString
* - Factory function that returns Promise of array of PipelineJson or PipelineString
*
* Note: This is useful as internal tool for other constructor functions like
* `createPipelineCollectionFromUrl` or `createPipelineCollectionFromDirectory`
* Consider using those functions instead of this one
*
* Note: The function does NOT return promise it returns the collection directly which waits for the sources to be resolved
* when error occurs in given promise or factory function, it is thrown during `listPipelines` or `getPipelineByUrl` call
*
* Note: Consider using `createPipelineCollectionFromDirectory` or `createPipelineCollectionFromUrl`
*
* @param promptbookSourcesPromiseOrFactory
* @returns PipelineCollection
* @deprecated Do not use, it will became internal tool for other constructor functions
* @public exported from `@promptbook/core`
*/
export declare function createPipelineCollectionFromPromise(promptbookSourcesPromiseOrFactory: Promise<ReadonlyArray<PipelineJson>> | (() => Promise<ReadonlyArray<PipelineJson>>)): PipelineCollection;