Class BasicRepresentation

Class with various constructors to facilitate creating a representation.

A representation consists of 1) data, 2) metadata, and 3) a binary flag to indicate whether the data is a binary stream or an object stream.

The data can be given as a stream, array, or string.
The metadata can be specified as one or two parameters that will be passed to the RepresentationMetadata constructor.
The binary field is optional, and if not specified, is determined from the content type inside the metadata.

Implements

Representation

Index

Constructors

Properties

binary data metadata

Accessors

Constructors

constructor

new BasicRepresentation(): BasicRepresentation
An empty Representation

Returns BasicRepresentation
- Defined in src/http/representation/BasicRepresentation.ts:30
new BasicRepresentation(data, metadata, binary?): BasicRepresentation
Parameters
- data:
      | string
      | Readable
      | unknown[]
      | Guarded<Readable>
  The representation data
- metadata: MetadataRecord | RepresentationMetadata
  The representation metadata
- Optionalbinary: boolean
  Whether the representation is a binary or object stream
Returns BasicRepresentation
- Defined in src/http/representation/BasicRepresentation.ts:37
new BasicRepresentation(data, metadata, contentType?, binary?): BasicRepresentation
Parameters
- data:
      | string
      | Readable
      | unknown[]
      | Guarded<Readable>
  The representation data
- metadata: MetadataRecord | RepresentationMetadata
  The representation metadata
- OptionalcontentType: string
  The representation's content type
- Optionalbinary: boolean
  Whether the representation is a binary or object stream
Returns BasicRepresentation
- Defined in src/http/representation/BasicRepresentation.ts:49
new BasicRepresentation(data, contentType, binary?): BasicRepresentation
Parameters
- data:
      | string
      | Readable
      | unknown[]
      | Guarded<Readable>
  The representation data
- contentType: string
  The representation's content type
- Optionalbinary: boolean
  Whether the representation is a binary or object stream
Returns BasicRepresentation
- Defined in src/http/representation/BasicRepresentation.ts:61
new BasicRepresentation(data, identifier, metadata?, binary?): BasicRepresentation
Parameters
- data:
      | string
      | Readable
      | unknown[]
      | Guarded<Readable>
  The representation data
- identifier: MetadataIdentifier
  The representation's identifier
- Optionalmetadata: MetadataRecord
  The representation metadata
- Optionalbinary: boolean
  Whether the representation is a binary or object stream
Returns BasicRepresentation
- Defined in src/http/representation/BasicRepresentation.ts:73
new BasicRepresentation(data, identifier, contentType?, binary?): BasicRepresentation
Parameters
- data:
      | string
      | Readable
      | unknown[]
      | Guarded<Readable>
  The representation data
- identifier: MetadataIdentifier
  The representation's identifier
- OptionalcontentType: string
  The representation's content type
- Optionalbinary: boolean
  Whether the representation is a binary or object stream
Returns BasicRepresentation
- Defined in src/http/representation/BasicRepresentation.ts:86

Properties

`Readonly`binary

binary: boolean

Whether the data stream consists of binary/string chunks (as opposed to complex objects).

`Readonly`data

data: Guarded<Readable>

The raw data stream for this representation.

`Readonly`metadata

metadata: RepresentationMetadata

The corresponding metadata.

Accessors

isEmpty

get isEmpty(): boolean
Data should only be interpreted if there is a content type.

Returns boolean
Implementation of Representation.isEmpty
- Defined in src/http/representation/BasicRepresentation.ts:125