Angular HAL Client - v1.0.0-dev.9
    Preparing search index...

    Class Resource

    This class represents an in-memory instance of a HAL resource.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    canCreate canDelete canRead canUpdate self

    Methods

    create delete follow get getArray mutate read update

    Constructors

    • Parameters

      • obj: Object

        the object used to assign the properties

      Returns Resource

    Accessors

    • get canCreate(): boolean

      This property is true when the self link exists and either methods array does not exist in the self link or the array exists and contains POST string. It is false otherwise.

      Returns boolean

    • get canDelete(): boolean

      This property is true when the self link exists and either methods array does not exist in the self link or the array exists and contains DELETE string. It is false otherwise.

      Returns boolean

    • get canRead(): boolean

      This property is true when the self link exists and either methods array does not exist in the self link or the array exists and contains GET string. It is false otherwise.

      Returns boolean

    • get canUpdate(): boolean

      This property is true when the self link exists and either methods array does not exist in the self link or the array exists and contains PUT string. It is false otherwise.

      Returns boolean

    • get self(): string

      The URI of self link.

      Returns string

    Methods

    • Create a new resource in the collection identified by self link. It makes a POST call to the URI in self link and returns an observable for the call. The observable emits an accessor for the newly created resource. The self link in the accessor may be set to undefined if Location header is not returned by the call.

      Parameters

      • obj: any

        the payload for the POST method call

      Returns Observable<Accessor>

      an observable of the resource's accessor

    • Delete the resource identified by self link.

      Returns Observable<void>

      an observable that emits next signal on successful delete

    • Follow the relation link. Returns an accessor for the resource. The self link in the accessor is set to undefined if no such relation exists.

      Parameters

      • rel: string

        the name of the relation link

      • params: Params = {}

        parameters for a templated link

      Returns Accessor

      an accessor for the linked resource

    • Returns a single embedded resource or undefined if no such embedded exists. If the named resource is an array it returns the first element.

      Type Parameters

      Parameters

      • type: Type<T>

        the resource type

      • rel: string

        the name of the embedded resource

      Returns T | undefined

      the resource or undefined

    • Returns an embedded array of resources or undefined if the named embedded does not exist. If the named resource is not an array it wraps the resource in an array.

      Type Parameters

      Parameters

      • type: Type<T>

        the element resource type

      • rel: string

        the name of the embedded resource array

      Returns T[] | undefined

      the resource array or undefined

    • Clones the resource instance and allows to modify the clone's properties using the provided function.

      Parameters

      • update: (x: this) => void

        the update function to apply to the clone

      Returns this

      the updated clone of the resource

    • Refresh the resource. In other words, read the resource identified by self link.

      Returns Observable<Resource>

      an observable of the refreshed resource instance

    • Persist the resource. Uses PUT request to send the new resource state.

      Returns Observable<Resource>

      an observable of the resource instance

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods