Type alias UploadOptions<S, B>

UploadOptions<S, B>: {
    auth?: SignedEvent | boolean;
    onAuth?: ((server, sha256, authType, blob) => Promise<SignedEvent>);
    onPayment?: ((server, sha256, blob, request) => Promise<PaymentToken>);
    signal?: AbortSignal;
    timeout?: number;
}

Type Parameters

Type declaration

  • Optional auth?: SignedEvent | boolean

    Override authorization event, or true to always use authorization, false to disable authorization

  • Optional onAuth?: ((server, sha256, authType, blob) => Promise<SignedEvent>)

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

      • (server, sha256, authType, blob): Promise<SignedEvent>

      • Parameters

        • server: S

          the server requesting the auth

        • sha256: string

          the sha256 of the blob being upload or mirror to the server

        • authType: "upload" | "media"
        • blob: B

          the original blob passed to the method

        Returns Promise<SignedEvent>

  • Optional onPayment?: ((server, sha256, blob, request) => Promise<PaymentToken>)

    A method used to request payment when uploading or mirroring a blob

      • (server, sha256, blob, request): Promise<PaymentToken>

      • Parameters

        • server: S

          the server requiring payment

        • sha256: string

          the sha256 of the blob being uploaded or mirrored

        • blob: B

          the original blob

        • request: PaymentRequest

          the payment request

        Returns Promise<PaymentToken>

  • Optional signal?: AbortSignal

    AbortSignal to cancel the action

  • Optional timeout?: number

    Request timeout

Settings

Member Visibility

Theme