BasicRepresentation | Community Solid Server

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

Properties

Accessors

isEmpty

Constructors

constructor

new BasicRepresentation(): BasicRepresentation
new BasicRepresentation(data: string | any[] | Readable | Guarded<Readable>, metadata: RepresentationMetadata | MetadataRecord, binary?: boolean): BasicRepresentation
new BasicRepresentation(data: string | any[] | Readable | Guarded<Readable>, metadata: RepresentationMetadata | MetadataRecord, contentType?: string, binary?: boolean): BasicRepresentation
new BasicRepresentation(data: string | any[] | Readable | Guarded<Readable>, contentType: string, binary?: boolean): BasicRepresentation
new BasicRepresentation(data: string | any[] | Readable | Guarded<Readable>, identifier: MetadataIdentifier, metadata?: MetadataRecord, binary?: boolean): BasicRepresentation
new BasicRepresentation(data: string | any[] | Readable | Guarded<Readable>, identifier: MetadataIdentifier, contentType?: string, binary?: boolean): BasicRepresentation

- Defined in src/http/representation/BasicRepresentation.ts:30
An empty Representation

Returns BasicRepresentation
- Defined in src/http/representation/BasicRepresentation.ts:37
An empty Representation

Parameters
- data: string | any[] | Readable | Guarded<Readable>
  The representation data
- metadata: RepresentationMetadata | 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:49
An empty Representation

Parameters
- data: string | any[] | Readable | Guarded<Readable>
  The representation data
- metadata: RepresentationMetadata | MetadataRecord
  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:61
An empty Representation

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:73
An empty Representation

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:86
An empty Representation

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

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

Implementation of Representation.isEmpty
- Defined in src/http/representation/BasicRepresentation.ts:124
Data should only be interpreted if there is a content type.

Returns boolean

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Constructors

constructor

Returns BasicRepresentation

Parameters

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

metadata: RepresentationMetadata | MetadataRecord

Optional binary: boolean

Returns BasicRepresentation

Parameters

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

metadata: RepresentationMetadata | MetadataRecord

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