Class Entity<T>

Represents a URI-addressable resource

Type Parameters

  • T extends object = object

    Type of the properties property

Hierarchy

  • Entity

Implements

Indexable

[extension: string]: unknown

Constructors

constructor

Properties

actions class entities links properties title?

Methods

accept getAction

Constructors

constructor

  • Type Parameters

    • T extends object = object

    Returns Entity<T>

Properties

actions

actions: Action[] = []

Available behavior exposed by the Entity

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.

entities

entities: SubEntity[] = []

Related entities represented as embedded links or representations

links

links: Link[] = []

Navigation links that communicate ways to navigate outside the entity graph

properties

properties: T = ...

Key-value pairs describing the state of the Entity

Optional title

title?: string

Descriptive text about the Entity

Methods

accept

getAction

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

    Parameters

    • name: string

    Returns undefined | Action

Settings

Member Visibility

Theme

Generated using TypeDoc