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.

Hierarchy

BasicRepresentation

Implements

Representation

Index

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 | any[] | Readable | Guarded<Readable>
  
  The representation data
- metadata: MetadataRecord | RepresentationMetadata
  
  The representation metadata
- Optional binary: 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 | any[] | Readable | Guarded<Readable>
  
  The representation data
- metadata: MetadataRecord | RepresentationMetadata
  
  The representation metadata
- Optional contentType: string
  
  The representation's content type
- Optional binary: 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 | any[] | Readable | Guarded<Readable>
  
  The representation data
- contentType: string
  
  The representation's content type
- Optional binary: 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 | any[] | Readable | Guarded<Readable>
  
  The representation data
- identifier: MetadataIdentifier
  
  The representation's identifier
- Optional metadata: MetadataRecord
  
  The representation metadata
- Optional binary: 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 | any[] | Readable | Guarded<Readable>
  
  The representation data
- identifier: MetadataIdentifier
  
  The representation's identifier
- Optional contentType: string
  
  The representation's content type
- Optional binary: 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:126

Class BasicRepresentation

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Constructors

constructor

Returns BasicRepresentation

Parameters

data: string | any[] | Readable | Guarded<Readable>

metadata: MetadataRecord | RepresentationMetadata

Optional binary: boolean

Returns BasicRepresentation

Parameters

data: string | any[] | Readable | Guarded<Readable>

metadata: MetadataRecord | RepresentationMetadata

Optional contentType: string

Optional binary: boolean

Returns BasicRepresentation

Parameters

data: string | any[] | Readable | Guarded<Readable>

contentType: string

Optional binary: boolean

Returns BasicRepresentation

Parameters

data: string | any[] | Readable | Guarded<Readable>

identifier: MetadataIdentifier

Optional metadata: MetadataRecord

Optional binary: boolean

Returns BasicRepresentation

Parameters

data: string | any[] | Readable | Guarded<Readable>

identifier: MetadataIdentifier

Optional contentType: string

Optional binary: boolean

Returns BasicRepresentation

Properties

Readonly binary

Readonly data

Readonly metadata

Accessors

isEmpty

Returns boolean

Settings

Member Visibility

Theme

On This Page

`Optional` binary: boolean

`Optional` contentType: string

`Optional` binary: boolean

`Optional` binary: boolean

`Optional` metadata: MetadataRecord

`Optional` binary: boolean

`Optional` contentType: string

`Optional` binary: boolean

`Readonly` binary

`Readonly` data

`Readonly` metadata