Stone.js API
    Preparing search index...

    Interface SignedUrlCapable

    Optional capability implemented by drivers that can mint short-lived signed URLs (object stores: S3/R2/OSS/COS, GCS, Azure Blob). It lets a client upload straight to storage and download private objects without proxying bytes through the app. Local/agnostic code should feature-detect with supportsSignedUrls rather than assume a driver implements it.

    interface SignedUrlCapable {
        temporaryUploadUrl: (
            path: string,
            options?: TemporaryUploadUrlOptions,
        ) => Promise<SignedUpload>;
        temporaryUrl: (
            path: string,
            options?: TemporaryUrlOptions,
        ) => Promise<string>;
    }
    Index
    temporaryUploadUrl temporaryUrl
    temporaryUploadUrl: (
        path: string,
        options?: TemporaryUploadUrlOptions,
    ) => Promise<SignedUpload>

    Mint a short-lived signed target to upload to path (direct-to-storage).

    Type Declaration

    temporaryUrl: (path: string, options?: TemporaryUrlOptions) => Promise<string>

    Mint a short-lived signed URL to download path.

    Type Declaration

      • (path: string, options?: TemporaryUrlOptions): Promise<string>

      • Parameters

        • path: string

          The object path (relative to the disk root/bucket).

        • Optionaloptions: TemporaryUrlOptions

          Expiry and response-header overrides.

        Returns Promise<string>

        The signed download URL.

    Settings
    Member Visibility

    On This Page
    Properties