Variable changeStatus

changeStatus: (
    record: any,
    status: string,
    reason: string,
    options?: any,
) => Promise<any> = ...

Type Declaration

- (record: any, status: string, reason: string, options?: any): Promise<any>
- Changes a stream's status and tells its receiver in SSF 1.0 section 8.1.5's order: stopping transmits stream-updated first and then changes the status; enabling changes it, transmits, and pushes what a paused stream held. No change sends nothing.
  Parameters
  - record: any
    the stream
  - status: string
    enabled, paused or disabled
  - reason: string
    why, for the event and the stream's log
  - Optionaloptions: any
    forHealth, for a pause this transmitter made because the receiver is unhealthy
  Returns Promise<any>
  a promise of { ok, errors, stream, report }; it never rejects