Media / foldkit-media/server

FileOptions

interface · packages/media/src/server/files.ts:92

interface FileOptions {
  readonly accept: Accept
  readonly maxBytes?: number
  readonly maxConcurrent?: number
  readonly minBytesPerSecond?: number
  readonly inspect?: (
    bytes: Uint8Array<ArrayBuffer>,
    declared: {
      readonly name: string
      readonly type: string
    },
  ) => Effect.Effect<void, FileRefused>
}

Members

FileOptions.accept

property · packages/media/src/server/files.ts:98

readonly accept: Accept

The declared types an upload may have: media types or type/* patterns, or '*' for any. The client writes the type, so this shapes the product and secures nothing: a download is never served as its type.

FileOptions.maxBytes

property · packages/media/src/server/files.ts:100

readonly maxBytes?: number

The largest file read, in bytes, counted as it streams; 20 MB by default.

FileOptions.maxConcurrent

property · packages/media/src/server/files.ts:105

readonly maxConcurrent?: number

Uploads read at once, each holding about twice its size; 2 by default. One past it, or a second from one owner, answers 503 rather than waiting.

FileOptions.minBytesPerSecond

property · packages/media/src/server/files.ts:107

readonly minBytesPerSecond?: number

The slowest a body may arrive, over each 10 seconds, before it is cut off (408); 32 KB/s by default.

FileOptions.inspect

property · packages/media/src/server/files.ts:109

readonly inspect?: (
  bytes: Uint8Array<ArrayBuffer>,
  declared: {
    readonly name: string
    readonly type: string
  },
) => Effect.Effect<void, FileRefused>

Reads the bytes before anything is kept: a magic-number check, a scan.