Class ChRISFeed

Class for managing individual ChRIS feeds.

Index

Constructors

Methods

client_get createFromDirs error_parse feedDetail_getFromPluginInstance

Constructors

constructor

new ChRISFeed(): ChRISFeed
Returns ChRISFeed
- Defined in packages/cumin/src/feeds/chrisFeed.ts:62

Methods

client_get

client_get(): Promise<Client | null>
Retrieves the ChRIS client instance asynchronously.

Returns Promise<Client | null>
A Promise resolving to the Client instance or null.
- Defined in packages/cumin/src/feeds/chrisFeed.ts:70

createFromDirs

createFromDirs(
dirs: string,
feedParams: ChRISObjectParams,
): Promise<SimpleRecord | null>
Parameters
- dirs: string
- feedParams: ChRISObjectParams
Returns Promise<SimpleRecord | null>
- Defined in packages/cumin/src/feeds/chrisFeed.ts:108

error_parse

error_parse(error: unknown, activity?: string): null
Parameters
- error: unknown
- Optionalactivity: string
Returns null
- Defined in packages/cumin/src/feeds/chrisFeed.ts:77

feedDetail_getFromPluginInstance

feedDetail_getFromPluginInstance(
pluginInstance: PluginInstance | null,
detailSpec: string[],
): Promise<SimpleRecord | null>
Parameters
- pluginInstance: PluginInstance | null
- detailSpec: string[]
Returns Promise<SimpleRecord | null>
- Defined in packages/cumin/src/feeds/chrisFeed.ts:86