@sovereignbase/storage
    Preparing search index...

    Function loadObject

    • Loads, decrypts, and decodes an object from a cache-first public URL.

      The Cache API is checked before the network. On a cache miss, the object is fetched from host + id; the hosting server therefore needs to make the exact URL publicly readable and, for cross-origin consumers, return an Access-Control-Allow-Origin header that permits them (typically *). A successful response is written back with standard HTTP cache headers whose freshness is refreshed to cacheFor milliseconds from the time of access. Cache hits receive the same refresh, giving frequently used objects sliding freshness.

      The callback is invoked after successful decryption and decoding. Its return value is ignored. A DOM consumer can intentionally start a load without awaiting it, finish constructing the surrounding UI, and hydrate the content from the callback when it becomes available.

      Invalid object URLs and non-successful HTTP responses complete without invoking onObjectLoaded. Cache, network, decompression, decryption, and decoding failures reject the returned promise.

      Parameters

      • id: string

        Object identifier appended directly to host. It must produce a URL whose path is exactly /${id} and which has no credentials, query, or fragment.

      • host: string

        HTTPS origin prefix ending in /, for example https://objects.example/.

      • cacheFor: number

        Sliding cache freshness in milliseconds. Each successful use refreshes Cache-Control, Date, and Expires.

      • cipherKeyBytes: Uint8Array

        Raw AES-GCM key bytes used to decrypt the object. The key must be valid for the Web Crypto API (16, 24, or 32 bytes).

      • onObjectLoaded: (object: unknown) => void

        Called once with the decoded object after a successful load. The callback's return value is not awaited.

      Returns Promise<void>

      A promise that settles after the load and callback invocation have been initiated. It does not adopt a promise returned by the callback.

      const article = document.createElement('article')
      article.textContent = 'Loading…'
      document.body.append(article)

      void loadObject(
        'welcome',
        'https://objects.example/',
        15 * 60 * 1000,
        key,
        (object) => {
          article.textContent = String(object)
        }
      )

    Settings
    Member Visibility