Guard / foldkit-guard/media

UploadPolicyConfig

interface · packages/guard/src/media.ts:19

interface UploadPolicyConfig<User, E, R> {
  readonly resolve: (
    request: Request,
  ) => Effect.Effect<Option.Option<User>, E, R>
  readonly Upload?: ReadonlyArray<PrincipalGuard<User>>
  readonly DescribeUrl?: ReadonlyArray<PrincipalGuard<User>>
}

Members

UploadPolicyConfig.resolve

property · packages/guard/src/media.ts:25

readonly resolve: (
  request: Request,
) => Effect.Effect<Option.Option<User>, E, R>

Who is asking, from a request holding the upload's URL, method and headers, and no body. A failure means it could not tell (an untrusted origin, a session that ended), answered 401; none is a visitor.

UploadPolicyConfig.Upload

property · packages/guard/src/media.ts:27

readonly Upload?: ReadonlyArray<PrincipalGuard<User>>

Who may upload: any one of these principal guards. Omitted, nobody.

UploadPolicyConfig.DescribeUrl

property · packages/guard/src/media.ts:29

readonly DescribeUrl?: ReadonlyArray<PrincipalGuard<User>>

Who may have an image named by URL described. Omitted, nobody.