Class MimeContent

Represents MIME content backed by a readable, seekable stream.

The content can be opened raw, copied as stored, or decoded according to its transfer encoding.

Index

Constructors

Properties

encoding newLineFormat stream

Methods

open writeTo decodeTo dispose

Constructors

constructor

new MimeContent(stream: Stream, encoding?: ContentEncoding): MimeContent
Initializes a new MIME content object.
Parameters
- stream: Stream
  The readable, seekable stream containing the encoded content.
- encoding: ContentEncoding = 'default'
  The transfer encoding used by the stream.
Returns MimeContent

Throws
stream is null, unreadable, or not seekable.
- Defined in src/mime-content.ts:30

Properties

`Readonly`encoding

encoding: ContentEncoding

The content-transfer-encoding used by the stored stream.

newLineFormat

newLineFormat: NewLineFormat | "mixed" | null = null

The detected newline format of the content, when known.

stream

stream: Stream | null

The backing stream, or null after disposal.

Methods

open

open(): Stream
Opens a decoded stream over the content.

Returns Stream
A filtered stream that decodes the content-transfer-encoding.
- Defined in src/mime-content.ts:43

writeTo

writeTo(stream: Stream): void
Writes the encoded content to another stream.
Parameters
- stream: Stream
  The destination stream.
Returns void

Throws
stream is null or this content has been disposed.
- Defined in src/mime-content.ts:57

decodeTo

decodeTo(stream: Stream): void
Decodes the content to another stream.
Parameters
- stream: Stream
  The destination stream.
Returns void

Throws
stream is null or this content has been disposed.
- Defined in src/mime-content.ts:71

dispose

dispose(): void
Releases the backing stream.

Returns void
- Defined in src/mime-content.ts:81