serverTypes/convert
@prismatic-io/spectral › "serverTypes/convert"
Index
Functions
Functions
Const
convertAction
▸ convertAction(actionKey
: string, __namedParameters
: object, hooks?
: ComponentHooks): ServerAction
Defined in packages/spectral/src/serverTypes/convert.ts:49
Parameters:
▪ actionKey: string
▪ __namedParameters: object
Name | Type |
---|---|
action | action |
inputs | object |
perform | function |
▪Optional
hooks: ComponentHooks
Returns: ServerAction
Const
convertComponent
▸ convertComponent‹TPublic, TKey›(__namedParameters
: object): ServerComponent
Defined in packages/spectral/src/serverTypes/convert.ts:167
Type parameters:
▪ TPublic: boolean
▪ TKey: string
Parameters:
▪ __namedParameters: object
Name | Type | Default |
---|---|---|
actions | object | - |
connections | (DefaultConnectionDefinition | OnPremiseConnectionDefinition | OAuth2AuthorizationCodeConnectionDefinition | OAuth2ClientCredentialConnectionDefinition)[] | [] |
dataSources | object | - |
definition | object | - |
hooks | undefined | ComponentHooks | - |
triggers | object | - |
Returns: ServerComponent
Const
convertConnection
▸ convertConnection(__namedParameters
: object): ServerConnection
Defined in packages/spectral/src/serverTypes/convert.ts:153
Parameters:
▪ __namedParameters: object
Name | Type |
---|---|
connection | connection | connection | connection | connection |
inputs | object | object | object | object |
Returns: ServerConnection
Const
convertDataSource
▸ convertDataSource(dataSourceKey
: string, __namedParameters
: object, hooks?
: ComponentHooks): ServerDataSource
Defined in packages/spectral/src/serverTypes/convert.ts:125
Parameters:
▪ dataSourceKey: string
▪ __namedParameters: object
Name | Type |
---|---|
dataSource | dataSource |
inputs | object |
perform | function |
▪Optional
hooks: ComponentHooks
Returns: ServerDataSource
Const
convertInput
▸ convertInput(key
: string, __namedParameters
: object): ServerInput
Defined in packages/spectral/src/serverTypes/convert.ts:23
Parameters:
▪ key: string
▪ __namedParameters: object
Name | Type |
---|---|
collection | undefined | "valuelist" | "keyvaluelist" |
defaultValue | unknown |
label | string | object |
rest | rest | rest | rest | rest | rest | rest | rest | rest | rest | rest | rest | rest | rest | rest | rest | rest | rest | rest | rest | rest | rest | rest | rest | rest | rest |
type | "string" | "boolean" | "conditional" | "connection" | "objectSelection" | "objectFieldMap" | "jsonForm" | "dynamicObjectSelection" | "dynamicFieldSelection" | "data" | "text" | "password" | "code" |
Returns: ServerInput
Const
convertTrigger
▸ convertTrigger(triggerKey
: string, __namedParameters
: object, hooks?
: ComponentHooks): ServerTrigger
Defined in packages/spectral/src/serverTypes/convert.ts:77
Parameters:
▪ triggerKey: string
▪ __namedParameters: object
Name | Type |
---|---|
inputs | object |
onInstanceDelete | undefined | function |
onInstanceDeploy | undefined | function |
perform | function |
trigger | trigger |
▪Optional
hooks: ComponentHooks
Returns: ServerTrigger