Class EmbeddedEntity<T>

Represents an embedded URI-addressable resource

Type Parameters

  • T extends object = object

Hierarchy

  • EmbeddedEntity

Implements

Indexable

[extensions: string]: unknown

Constructors

Properties

actions: Action[] = []

Available behavior exposed by the EmbeddedEntity

class: string[] = []

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

entities: SubEntity[] = []

Related entities represented as embedded links or representations

links: Link[] = []

Navigation links that communicate ways to navigate outside the entity graph

properties: T = ...

Key-value pairs describing the state of the Entity

rel: string[]

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

title?: string

Descriptive text about the Entity

Methods

  • Returns the Action in actions with the given name, if it exists. Otherwise, returns undefined.

    Parameters

    • name: string

    Returns undefined | Action

Generated using TypeDoc