Variable streamEvents

Type Declaration

• • (
        record: any,
        attribute: string,
        form: Record<string, string>,
        options?: any,
    ): Promise<any>

  • Posts a form to a registered address and reads the answer as server-sent events, calling onEvent for each; used for OpenID Provider Commands' tenant commands.

    The timeout is an idle timeout; an answer that is not text/event-stream is read whole and returned as body. Never rejects.

    Parameters

    • record: any

      the entry carrying the address under attribute

    • attribute: string

      the attribute holding the address, one of SENDABLE

    • form: Record<string, string>

      the form body

    • Optionaloptions: any

      idleMs, maxBytes, maxEvents, lastEventId and onEvent({ id, event, data })

    Returns Promise<any>

    a promise of { ok, status, kind, why, url, events, lastEventId, ended, body, contentType }