Class PayloadStreamReader

A FDv2 PayloadStreamReader can be used to parse payloads from a stream of FDv2 events. See PayloadProcessor for more details.

Hierarchy

PayloadStreamReader

Index

Constructors

Properties

_attachHandler _errorHandler? _logger? _payloadProcessor

Methods

addPayloadListener removePayloadListener

Constructors

constructor

new PayloadStreamReader(eventStream, _objProcessors, _errorHandler?, _logger?): PayloadStreamReader
Creates a PayloadStreamReader
Parameters
- eventStream: EventStream
  
  event stream of FDv2 events
- _objProcessors: ObjProcessors
  
  defines object processors for each object kind.
- Optional _errorHandler: ((errorKind, message) => void)
  
  that will be called with parsing errors as they are encountered
  
  Optional
  - - (errorKind, message): void
    - Parameters
      
      errorKind: DataSourceErrorKind
      
      message: string
      
      Returns void
- Optional _logger: LDLogger
  
  for logging
  
  Optional
Returns PayloadStreamReader
- Defined in packages/shared/common/dist/esm/internal/fdv2/payloadStreamReader.d.ts:26

Properties

`Private` _attachHandler

_attachHandler: any

`Private` `Optional` `Readonly` _errorHandler

_errorHandler?: any

`Private` `Optional` `Readonly` _logger

_logger?: any

`Private` _payloadProcessor

_payloadProcessor: any

Methods

addPayloadListener

addPayloadListener(listener): void
Parameters
- listener: PayloadListener
Returns void
- Defined in packages/shared/common/dist/esm/internal/fdv2/payloadStreamReader.d.ts:27

removePayloadListener

removePayloadListener(listener): void
Parameters
- listener: PayloadListener
Returns void
- Defined in packages/shared/common/dist/esm/internal/fdv2/payloadStreamReader.d.ts:28

Generated using TypeDoc