import SirenAction from 'super-siren/lib/SirenAction.js'

public class | source

SirenAction

You can directly use instance of this class. sirenAction

Representation of a Siren action, which allows a state within a Siren Hypermedia API to transition to a new state.

Static Member Summary

Static Public Members
public static get	empty: SirenAction: * Default state for a SirenAction.

Static Public Methods
public static	fromJson(json: Object, baseUrl: String): SirenAction Creates a SirenAction instance based on the provided

Public Methods
public	perform(data: Object): superagent-promise Performs the action specified by this Action.

Default state for a SirenAction. This has the defaults set and nothing else.

Siren Action which is created as a result of parsing the provided JSON.

Creates a SirenAction instance based on the provided JSON object structure.

Name	Type	Attribute	Description
json	Object		Object which matches the Siren JSON structure.
baseUrl	String	optional	optional url to use as the base URL for all parsed URLs

Result of parsing the provided JSON object.

Performs the action specified by this Action.

Name	Type	Attribute	Description
data	Object		Data to be sent as part of this action

superagent-promise

superagent promise representing the HTTP request to perform this action