types

@prismatic-io/spectral"types"

Index

Interfaces

Type aliases

Type aliases

ActionPerformFunction

Ƭ ActionPerformFunction: function

Definition of the function to perform when an Action is invoked.

Type declaration:

▸ (context: ActionContext, params: ActionInputParameters): Promise‹PerformReturn

Parameters:

NameType
contextActionContext
paramsActionInputParameters

AuthorizationMethod

Ƭ AuthorizationMethod: "api_key_secret" | "basic" | "private_key" | "api_key" | "oauth2"


ConfigurationVariablesCollection

Ƭ ConfigurationVariablesCollection: Record‹string, string›


InputFieldCollection

Ƭ InputFieldCollection: "scalar" | "keyvalue"

InputField collection enumeration


InputFieldModelFunction

Ƭ InputFieldModelFunction: function

Definition of the function that returns an array of choices.

Type declaration:

▸ (): Promise‹InputFieldChoice[]›


InputFieldType

Ƭ InputFieldType: "string" | "text" | "password" | "boolean" | "code" | "data"

InputField type enumeration.


PerformReturn

Ƭ PerformReturn: PerformDataStructureReturn | PerformDataReturn | void

Required return type of all action perform functions

Last updated on