PluginConnectionPropertyOption

Metadata and methods to return the options a Property for this connection/app. Options is a method which will poll the source for available options to select (ie: names of tables or columns)

Hierarchy

PluginConnectionPropertyOption

Index

Properties

description

description: string

Optional displayName

displayName: string

key

key: string

options

options: (argument: { app: App; appId: string; appOptions: SimpleAppOptions; connection: any; property: Property; propertyId: string; source: Source; sourceId: string; sourceMapping: SourceMapping; sourceOptions: SimpleSourceOptions }) => Promise<{ description?: string; examples?: any[]; key: string }[]>

Type declaration

- (argument: { app: App; appId: string; appOptions: SimpleAppOptions; connection: any; property: Property; propertyId: string; source: Source; sourceId: string; sourceMapping: SourceMapping; sourceOptions: SimpleSourceOptions }): Promise<{ description?: string; examples?: any[]; key: string }[]>
- Parameters
  - argument: { app: App; appId: string; appOptions: SimpleAppOptions; connection: any; property: Property; propertyId: string; source: Source; sourceId: string; sourceMapping: SourceMapping; sourceOptions: SimpleSourceOptions }
    - app: App
    - appId: string
    - appOptions: SimpleAppOptions
    - connection: any
    - property: Property
    - propertyId: string
    - source: Source
    - sourceId: string
    - sourceMapping: SourceMapping
    - sourceOptions: SimpleSourceOptions
  Returns Promise<{ description?: string; examples?: any[]; key: string }[]>

required

required: boolean

type

type: string

Hierarchy

Index

Properties

Properties

description

Optional displayName

key

options

Type declaration

Parameters

argument: { app: App; appId: string; appOptions: SimpleAppOptions; connection: any; property: Property; propertyId: string; source: Source; sourceId: string; sourceMapping: SourceMapping; sourceOptions: SimpleSourceOptions }

app: App

appId: string

appOptions: SimpleAppOptions

connection: any

property: Property

propertyId: string

source: Source

sourceId: string

sourceMapping: SourceMapping

sourceOptions: SimpleSourceOptions

Returns Promise<{ description?: string; examples?: any[]; key: string }[]>

required

type