Beignet API reference
    Preparing search index...

    Function createS3StorageProvider

    • Create an env-backed S3-compatible storage provider.

      Reads STORAGE_S3_* env vars, contributes ports.storage, and exposes ports.s3Storage for raw client access and key-prefix helpers.

      Parameters

      Returns ServiceProvider<
          unknown,
          ZodObject<
              {
                  ACCESS_KEY_ID: ZodOptional<ZodString>;
                  BUCKET: ZodString | ZodDefault<ZodString>;
                  ENDPOINT: ZodDefault<ZodString> | ZodOptional<ZodString>;
                  FORCE_PATH_STYLE:
                      | ZodOptional<
                          ZodPipe<
                              ZodEnum<{ false: "false"; true: "true" }>,
                              ZodTransform<boolean, "true" | "false">,
                          >,
                      >
                      | ZodDefault<
                          ZodPipe<
                              ZodEnum<{ false: "false"; true: "true" }>,
                              ZodTransform<boolean, "true" | "false">,
                          >,
                      >;
                  KEY_PREFIX: ZodDefault<ZodString> | ZodOptional<ZodString>;
                  PUBLIC_BASE_URL: ZodDefault<ZodString> | ZodOptional<ZodString>;
                  REGION: ZodDefault<ZodString>;
                  SECRET_ACCESS_KEY: ZodOptional<ZodString>;
                  SESSION_TOKEN: ZodOptional<ZodString>;
              },
              $strip,
          >,
          {
              s3Storage: {
                  bucket: string;
                  client: S3StorageClient;
                  keyPrefix: string;
                  objectKey(key: string): string;
                  objectPrefix(prefix: string): string;
              };
              storage: StoragePort;
          },
      >

    Settings

    Member Visibility