Class ReconApi

Recon API Interface

Hierarchy

Observable<ReconEventFeedResponse>
- ReconApi

Implements

IReconApi

Index

Constructors

Accessors

Methods

init put registerInterest stop

Constructors

constructor

new ReconApi(config: ReconApiConfig, logger: DiagnosticsLogger, sendRequest?: FetchRequest, pollInterval?: number): ReconApi
Parameters
- config: ReconApiConfig
- logger: DiagnosticsLogger
- sendRequest: FetchRequest = fetchJson
- pollInterval: number = DEFAULT_POLL_INTERVAL
Returns ReconApi
Overrides Observable<ReconEventFeedResponse>.constructor
- Defined in packages/core/src/recon.ts:79

Accessors

enabled

get enabled(): boolean
Whether the Recon API is enabled

Returns boolean
Implementation of IReconApi.enabled
- Defined in packages/core/src/recon.ts:171

Methods

init

init(initialCursor?: string): Promise<void>
Initialization tasks. Registers interest in the model and starts polling the feed for new events to emit to subscribers.

Returns
Parameters
- initialCursor: string = '0'
Returns Promise<void>
Implementation of IReconApi.init
- Defined in packages/core/src/recon.ts:100

put

put(event: ReconEvent, opts?: AbortOptions): Promise<void>
Put an event to the Recon API

Returns
Parameters
- event: ReconEvent
  
  The event to put
- opts: AbortOptions = {}
  
  Abort options
Returns Promise<void>
Implementation of IReconApi.put
- Defined in packages/core/src/recon.ts:146

registerInterest

registerInterest(model: StreamID): Promise<void>
Registers interest in a model
Parameters
- model: StreamID
  
  stream id of the model to register interest in
Returns Promise<void>
Implementation of IReconApi.registerInterest
- Defined in packages/core/src/recon.ts:123

stop

stop(): void
Stops the Recon API. This stops the polling and sends a complete signal to subscribers.

Returns void
Implementation of IReconApi.stop
- Defined in packages/core/src/recon.ts:178