Interface EmbeddedEntity<T>

Represents an embedded URI-addressable resource

Type Parameters

  • T extends object = object

Hierarchy

Properties

actions? class? entities? links? properties? rel title?

Properties

Optional actions

actions?: Action[]

Available behavior exposed by the Entity

Optional class

class?: string[]

List of strings describing the nature of the Entity based on the current representation. Possible values are implementation-dependent and should be documented.

Optional entities

entities?: SubEntity[]

Related entities represented as embedded links or representations

Optional links

links?: Link[]

Navigation links that communicate ways to navigate outside the entity graph

Optional properties

properties?: T

Key-value pairs describing the state of the Entity

rel

rel: string[]

List of strings describing the relationship of the EmbeddedEntity to its parent, per RFC 8288.

Optional title

title?: string

Descriptive text about the Entity

Settings

Member Visibility

Theme

Generated using TypeDoc