Type alias ListOptions<S>

ListOptions<S>: {
    auth?: SignedEvent;
    onAuth?: ((server) => Promise<SignedEvent>);
    onPayment?: ((server, request) => Promise<Token>);
    signal?: AbortSignal;
    since?: number;
    timeout?: number;
    until?: number;
}

Type Parameters

Type declaration

  • Optional auth?: SignedEvent

    Override auth event to use

  • Optional onAuth?: ((server) => Promise<SignedEvent>)

    A method used to request a signed auth event for a server

  • Optional onPayment?: ((server, request) => Promise<Token>)

    A method used to request payment

      • (server, request): Promise<Token>

      • Parameters

        • server: S

          the server requiring payment

        • request: PaymentRequest

          the payment request

        Returns Promise<Token>

  • Optional signal?: AbortSignal

    AbortSignal to cancel the action

  • Optional since?: number
  • Optional timeout?: number

    Request timeout

  • Optional until?: number

Settings

Member Visibility

Theme