Documentation

Documentation / @zerotal/flow / index / UploadRef

Interface: UploadRef

Defined in: flow/src/uploads/TemporaryUploadedFile.ts:37

What the /__flow/upload endpoint returns and the client $sets onto a component property — TufData plus a self-describing marker and its own HMAC signature.

Remarks

The signature lets the server trust a client-supplied ref: on $set it is verified (see TemporaryUploadedFile.fromSignedRef) before wrapping into a TemporaryUploadedFile. A forged or altered ref fails verification and is discarded.

Extends

• TufData

Properties

tmpPath

tmpPath: string

Defined in: flow/src/uploads/TemporaryUploadedFile.ts:15

Path of the uploaded bytes on the temp disk.

Inherited from

TufData.tmpPath

originalName

originalName: string

Defined in: flow/src/uploads/TemporaryUploadedFile.ts:17

The client-supplied original filename (used to derive the stored extension).

Inherited from

TufData.originalName

mime

mime: string

Defined in: flow/src/uploads/TemporaryUploadedFile.ts:19

The upload's MIME type.

Inherited from

TufData.mime

size

size: number

Defined in: flow/src/uploads/TemporaryUploadedFile.ts:21

Size of the upload in bytes.

Inherited from

TufData.size

tempDisk?

optional tempDisk?: string

Defined in: flow/src/uploads/TemporaryUploadedFile.ts:23

Name of the temp disk the bytes live on (default disk when omitted).

Inherited from

TufData.tempDisk

__flow_upload

__flow_upload: true

Defined in: flow/src/uploads/TemporaryUploadedFile.ts:39

Discriminator marking this object as a flow upload reference.

sig

sig: string

Defined in: flow/src/uploads/TemporaryUploadedFile.ts:41

HMAC signature over the signed payload of TufData fields.