Class Attachments

A container for vendor-specific metadata attachments.

Attachments provides a flexible mechanism for attaching arbitrary metadata to envelopes without modifying their core structure.

Index

Constructors

Methods

add get remove clear isEmpty addToEnvelope fromEnvelope

Constructors

constructor

new Attachments(): Attachments
Creates a new empty attachments container.

Returns Attachments
- Defined in envelope/src/extension/attachment.ts:49

Methods

add

add(payload: EnvelopeEncodableValue, vendor: string, conformsTo?: string): void
Adds a new attachment with the specified payload and metadata.
Parameters
- payload: EnvelopeEncodableValue
  The data to attach
- vendor: string
  A string identifying the entity that defined the attachment format
- OptionalconformsTo: string
  Optional URI identifying the structure the payload conforms to
Returns void
- Defined in envelope/src/extension/attachment.ts:58

get

get(digest: Digest): Envelope | undefined
Retrieves an attachment by its digest.
Parameters
- digest: Digest
  The unique digest of the attachment to retrieve
Returns Envelope | undefined
The envelope if found, or undefined
- Defined in envelope/src/extension/attachment.ts:69

remove

remove(digest: Digest): Envelope | undefined
Removes an attachment by its digest.
Parameters
- digest: Digest
  The unique digest of the attachment to remove
Returns Envelope | undefined
The removed envelope if found, or undefined
- Defined in envelope/src/extension/attachment.ts:79

clear

clear(): void
Removes all attachments from the container.

Returns void
- Defined in envelope/src/extension/attachment.ts:88

isEmpty

isEmpty(): boolean
Returns whether the container has any attachments.

Returns boolean
- Defined in envelope/src/extension/attachment.ts:95

addToEnvelope

addToEnvelope(envelope: Envelope): Envelope
Adds all attachments from this container to an envelope.
Parameters
- envelope: Envelope
  The envelope to add attachments to
Returns Envelope
A new envelope with all attachments added as assertions
- Defined in envelope/src/extension/attachment.ts:105

`Static`fromEnvelope

fromEnvelope(envelope: Envelope): Attachments
Creates an Attachments container from an envelope's attachment assertions.
Parameters
- envelope: Envelope
  The envelope to extract attachments from
Returns Attachments
A new Attachments container with the envelope's attachments
- Defined in envelope/src/extension/attachment.ts:119