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

Accessors

Methods

add addEnvelope get remove clear [iterator] equals addToEnvelope fromEnvelope

Constructors

constructor

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

Returns Attachments
- Defined in extension/attachment.ts:36

Accessors

size

get size(): number
How many attachments are stored.

Returns number
- Defined in extension/attachment.ts:89

Methods

add

add(payload: EnvelopeInput, vendor: string, conformsTo?: string): void
Adds a new attachment with the specified payload and metadata.
Parameters
- payload: EnvelopeInput
  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 extension/attachment.ts:45

addEnvelope

addEnvelope(envelope: Envelope): void
Adds a pre-constructed attachment envelope directly.
Parameters
- envelope: Envelope
  The attachment envelope to add
Returns void
- Defined in extension/attachment.ts:55

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 extension/attachment.ts:65

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 extension/attachment.ts:75

clear

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

Returns void
- Defined in extension/attachment.ts:84

[iterator]

"[iterator]"(): IterableIterator<Envelope>
The stored attachment envelopes.

Returns IterableIterator<Envelope>
- Defined in extension/attachment.ts:94

equals

equals(other: Attachments): boolean
Check equality with another Attachments container.
Parameters
- other: Attachments
Returns boolean
- Defined in extension/attachment.ts:101

addToEnvelope

addToEnvelope(envelope: Envelope): Envelope
Adds all attachments from this container to an envelope, each stored 'attachment' assertion as it is (they are assertion envelopes already).
Parameters
- envelope: Envelope
  The envelope to add attachments to
Returns Envelope
A new envelope with all attachments added as assertions
- Defined in extension/attachment.ts:116

`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 extension/attachment.ts:130