sailfork / t3code-github / .repos/ alchemy-effect/ packages/ fly/ src/ HeadObject.ts

import type * as S3 from "@distilled.cloud/aws/s3";
import * as Binding from "alchemy/Binding";
import type { RuntimeContext } from "alchemy/RuntimeContext";
import type * as Effect from "effect/Effect";
import type { Bucket } from "./Bucket.ts";
import type { TigrisCredentialsMissing } from "./Errors.ts";

export interface HeadObjectRequest extends Omit<S3.HeadObjectRequest, "Bucket"> {}

/**
 * Runtime binding for Tigris `HeadObject` over the S3 API.
 *
 * Bind this operation to a {@link Bucket} in Service init. Provide
 * {@link HeadObjectHttp}.
 *
 *
 * ### Inspecting Objects
 * **Example:** Check an Object's Metadata
 * ```typescript
 * const headObject = yield* Fly.HeadObject(Data);
 * const head = yield* headObject({ Key: "hello.txt" });
 * ```
 *
 * @binding
 * @product Bucket
 */
export interface HeadObject extends Binding.Service<
  HeadObject,
  "Fly.HeadObject",
  (
    bucket: Bucket,
  ) => Effect.Effect<
    (
      request: HeadObjectRequest,
    ) => Effect.Effect<
      S3.HeadObjectOutput,
      S3.HeadObjectError | TigrisCredentialsMissing,
      RuntimeContext
    >
  >
> {}

export const HeadObject = Binding.Service<HeadObject>("Fly.HeadObject");