Skip to main content

ServerPerformBranchingDataStructureReturn

@prismatic-io/spectral"types/server-types"ServerPerformBranchingDataStructureReturn

Used to represent a branching return of conventional data and does not require content type to be specified

Hierarchy#

Index#

Properties#

Properties#

branch#

branch: string

Defined in types/server-types.ts:102

Name of the Branch to take.


Optional contentType#

contentType? : undefined | string

Inherited from ServerPerformDataStructureReturn.contentType

Defined in types/server-types.ts:79

The Content Type of the payload data that can be optionally specified


data#

data: boolean | number | string | Record‹string, unknown› | unknown[] | unknown

Inherited from ServerPerformDataStructureReturn.data

Defined in types/server-types.ts:71

Data structure to return from the action


Optional state#

state? : Record‹string, unknown›

Inherited from ServerPerformDataStructureReturn.state

Defined in types/server-types.ts:83

An optional object, the keys and values of which will be persisted in the instanceState and available for subsequent actions and executions


Optional statusCode#

statusCode? : undefined | number

Inherited from ServerPerformDataStructureReturn.statusCode

Defined in types/server-types.ts:81

The HTTP Status code that will be used if this terminates a synchronous invocation