Class AgentJsonParser

A parser that extracts Agent data from a JSON body.

Hierarchy

AgentParser
- AgentJsonParser

Index

Constructors

constructor

Methods

Constructors

constructor

new AgentJsonParser(): AgentJsonParser

Inherited from AgentParser.constructor

Returns AgentJsonParser

Methods

canHandle

canHandle(input: Representation): Promise<void>

Overrides AgentParser.canHandle
- Defined in src/pods/agent/AgentJsonParser.ts:17
Parameters
- input: Representation
Returns Promise<void>

handle

handle(input: Representation): Promise<Agent>

Overrides AgentParser.handle
- Defined in src/pods/agent/AgentJsonParser.ts:23
Parameters
- input: Representation
Returns Promise<Agent>

handleSafe

handleSafe(input: Representation): Promise<Agent>

Inherited from AgentParser.handleSafe
- Defined in src/util/AsyncHandler.ts:35
Helper function that first runs the canHandle function followed by the handle function. Throws the error of the canHandle function if the data can't be handled, or returns the result of the handle function otherwise.

Parameters
- input: Representation
  
  Input data that will be handled if it can be handled.
Returns Promise<Agent>

A promise resolving if the input can be handled, rejecting with an Error if not. Return value depends on the given type.

Private isJSON

isJSON(mediaType: string): boolean

- Defined in src/pods/agent/AgentJsonParser.ts:29
Parameters
- mediaType: string
Returns boolean

Private isValidAgent

isValidAgent(data: Dict<string>): asserts data is Agent

- Defined in src/pods/agent/AgentJsonParser.ts:36
Checks if all keys in the object are valid Agent keys and if all required keys are there.

Parameters
- data: Dict<string>
Returns asserts data is Agent