ENGLISH·COURSE API
    Preparing search index...

    Function

    objectPathFor

    • Where a key's bytes sit inside a GIVEN store, by inference alone.

      Parameters

      • key: string
      • store:
            | { driver: "local"; baseUrl: string; pathPrefix: string }
            | {
                driver: "s3";
                bucket: string;
                region: string;
                endpoint?: string;
                forcePathStyle: boolean;
                pathPrefix: string;
                visibility: "public" | "signed";
                publicUrl?: string;
                signedUrlTtlSeconds?: number;
            }
            | {
                driver: "gcs";
                bucket: string;
                apiEndpoint?: string;
                pathPrefix: string;
                visibility: "public"
                | "signed";
                publicUrl?: string;
                signedUrlTtlSeconds?: number;
            }
        • { driver: "local"; baseUrl: string; pathPrefix: string }
          • driver: "local"
          • baseUrl: string

            Public URL prefix, without a trailing slash.

          • pathPrefix: string
        • {
              driver: "s3";
              bucket: string;
              region: string;
              endpoint?: string;
              forcePathStyle: boolean;
              pathPrefix: string;
              visibility: "public" | "signed";
              publicUrl?: string;
              signedUrlTtlSeconds?: number;
          }
          • driver: "s3"
          • bucket: string
          • region: string
          • Optionalendpoint?: string

            Custom endpoint for S3-compatible stores (R2, MinIO, LocalStack). Omit for AWS itself, where the SDK derives the endpoint from the region.

          • forcePathStyle: boolean

            Path-style addressing, which most S3-compatible stores require.

          • pathPrefix: string
          • visibility: "public" | "signed"
          • OptionalpublicUrl?: string

            Public URL prefix (usually a CDN). Required when visibility is public.

          • OptionalsignedUrlTtlSeconds?: number

            Seconds a signed URL stays valid. See DEFAULT_SIGNED_URL_TTL_SECONDS.

        • {
              driver: "gcs";
              bucket: string;
              apiEndpoint?: string;
              pathPrefix: string;
              visibility: "public" | "signed";
              publicUrl?: string;
              signedUrlTtlSeconds?: number;
          }
          • driver: "gcs"
          • bucket: string
          • OptionalapiEndpoint?: string

            Custom API endpoint, for emulators. Omit for Google Cloud itself.

          • pathPrefix: string
          • visibility: "public" | "signed"
          • OptionalpublicUrl?: string
          • OptionalsignedUrlTtlSeconds?: number

      Returns string

      Ignores any declared placement, so it answers "where would this key live in this store" — which is what a move needs when it is deciding where to put an object. Callers resolving a key for reading want resolveObjectPathFor instead.

    Settings

    Member Visibility