Class AgentJsonParser

A parser that extracts Agent data from a JSON body.

Hierarchy

AgentParser
- AgentJsonParser

Index

Methods

Methods

canHandle

canHandle(input: Representation): Promise<void>

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

handle

handle(input: Representation): Promise<Agent>

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

handleSafe

handleSafe(data: Representation): Promise<Agent>

Inherited from AsyncHandler.handleSafe
- Defined in src/util/AsyncHandler.ts:33
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
- data: Representation
  
  The data to handle.
Returns Promise<Agent>

The result of the handle function of the handler.

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>): assertsdata 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 assertsdata is Agent