iya-sts
    Preparing search index...

    Variable pushSet

    pushSet: (
        url: unknown,
        token: unknown,
        options?: PushOptions,
    ) => Promise<PushResult> = ...

    Type Declaration

      • (url: unknown, token: unknown, options?: PushOptions): Promise<PushResult>
      • Pushes one SET to a receiver's endpoint.

        A 202 is success; a 400 with err/description is the receiver refusing; anything else is a failure to deliver. The promise never rejects.

        Parameters

        • url: unknown

          the stream's delivery.endpoint_url

        • token: unknown

          the signed SET, as a compact JWS

        • Optionaloptions: PushOptions

          authorizationHeader, sent as the Authorization header

        Returns Promise<PushResult>

        a promise of { ok, status, err, description, why, errorCode, retryable }