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

Constructors

constructor

new BasicRepresentation(data: string | any[] | Readable | Guarded<Readable>, metadata: RepresentationMetadata | Record<string, MetadataValue>, binary?: boolean): BasicRepresentation
new BasicRepresentation(data: string | any[] | Readable | Guarded<Readable>, metadata: RepresentationMetadata | Record<string, MetadataValue>, 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?: Record<string, MetadataValue>, binary?: boolean): BasicRepresentation
new BasicRepresentation(data: string | any[] | Readable | Guarded<Readable>, identifier: MetadataIdentifier, contentType?: string, binary?: boolean): BasicRepresentation

- Defined in src/ldp/representation/BasicRepresentation.ts:25
Parameters
- data: string | any[] | Readable | Guarded<Readable>
  
  The representation data
- metadata: RepresentationMetadata | Record<string, MetadataValue>
  
  The representation metadata
- Optional binary: boolean
  
  Whether the representation is a binary or object stream
Returns BasicRepresentation
- Defined in src/ldp/representation/BasicRepresentation.ts:36
Parameters
- data: string | any[] | Readable | Guarded<Readable>
  
  The representation data
- metadata: RepresentationMetadata | Record<string, MetadataValue>
  
  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/ldp/representation/BasicRepresentation.ts:49
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/ldp/representation/BasicRepresentation.ts:60
Parameters
- data: string | any[] | Readable | Guarded<Readable>
  
  The representation data
- identifier: MetadataIdentifier
  
  The representation's identifier
- Optional metadata: Record<string, MetadataValue>
  
  The representation metadata
- Optional binary: boolean
  
  Whether the representation is a binary or object stream
Returns BasicRepresentation
- Defined in src/ldp/representation/BasicRepresentation.ts:73
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

Readonly data

data: Guarded<Readable>

Readonly metadata

metadata: RepresentationMetadata

Hierarchy

Implements

Index

Constructors

Properties

Constructors

constructor

Parameters

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

metadata: RepresentationMetadata | Record<string, MetadataValue>

Optional binary: boolean

Returns BasicRepresentation

Parameters

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

metadata: RepresentationMetadata | Record<string, MetadataValue>

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: Record<string, MetadataValue>

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