Search
Preparing search index...
The search index is not available
@grouparoo/core
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
@grouparoo/core
PluginConnection
Interface PluginConnection
A plugin's Connection
Hierarchy
PluginConnection
Index
Properties
apps
default
Sync
Mode
description
direction
display
Name
group
Aggregations
methods
name
options
skip
Source
Mapping
support
Incremental
Schedule
sync
Modes
Properties
apps
apps
:
string
[]
Optional
default
Sync
Mode
default
Sync
Mode
?:
"sync"
|
"additive"
|
"enrich"
description
description
:
string
direction
direction
:
"import"
|
"export"
display
Name
display
Name
:
string
Optional
group
Aggregations
group
Aggregations
?:
AggregationMethod
[]
Optional
methods
methods
?:
{
destinationMappingOptions
?:
DestinationMappingOptionsMethod
<
any
>
;
destinationOptions
?:
DestinationOptionsMethod
<
any
>
;
exportArrayProperties
?:
ExportArrayPropertiesMethod
<
any
>
;
exportRecord
?:
ExportRecordPluginMethod
<
any
>
;
exportRecords
?:
ExportRecordsPluginMethod
<
any
>
;
importRecords
?:
RecordsPluginMethod
<
any
>
;
processExportedRecords
?:
ProcessExportedRecordsPluginMethod
<
any
>
;
propertyOptions
?:
PropertyOptionsMethod
;
recordProperties
?:
RecordPropertiesPluginMethod
<
any
>
;
recordProperty
?:
RecordPropertyPluginMethod
<
any
>
;
scheduleOptions
?:
ScheduleOptionsMethod
;
sourceFilters
?:
SourceFilterMethod
<
any
>
;
sourceOptions
?:
SourceOptionsMethod
<
any
>
;
sourcePreview
?:
SourcePreviewMethod
<
any
>
;
sourceRunPercentComplete
?:
SourceRunPercentCompleteMethod
<
any
>
;
uniquePropertyBootstrapOptions
?:
UniquePropertyBootstrapOptions
<
any
>
}
Type declaration
Optional
destination
Mapping
Options
?:
DestinationMappingOptionsMethod
<
any
>
Optional
destination
Options
?:
DestinationOptionsMethod
<
any
>
Optional
export
Array
Properties
?:
ExportArrayPropertiesMethod
<
any
>
Optional
export
Record
?:
ExportRecordPluginMethod
<
any
>
Optional
export
Records
?:
ExportRecordsPluginMethod
<
any
>
Optional
import
Records
?:
RecordsPluginMethod
<
any
>
Optional
process
Exported
Records
?:
ProcessExportedRecordsPluginMethod
<
any
>
Optional
property
Options
?:
PropertyOptionsMethod
Optional
record
Properties
?:
RecordPropertiesPluginMethod
<
any
>
Optional
record
Property
?:
RecordPropertyPluginMethod
<
any
>
Optional
schedule
Options
?:
ScheduleOptionsMethod
Optional
source
Filters
?:
SourceFilterMethod
<
any
>
Optional
source
Options
?:
SourceOptionsMethod
<
any
>
Optional
source
Preview
?:
SourcePreviewMethod
<
any
>
Optional
source
Run
Percent
Complete
?:
SourceRunPercentCompleteMethod
<
any
>
Optional
unique
Property
Bootstrap
Options
?:
UniquePropertyBootstrapOptions
<
any
>
name
name
:
string
options
options
:
ConnectionOptionsOption
[]
Optional
skip
Source
Mapping
skip
Source
Mapping
?:
boolean
Optional
support
Incremental
Schedule
support
Incremental
Schedule
?:
boolean
Optional
sync
Modes
sync
Modes
?:
(
"sync"
|
"additive"
|
"enrich"
)
[]
Exports
Errors
GrouparooCLI
Status
Table
Speculation
plugin
Plugin
Connection
apps
default
Sync
Mode
description
direction
display
Name
group
Aggregations
methods
name
options
skip
Source
Mapping
support
Incremental
Schedule
sync
Modes
Generated using
TypeDoc
A plugin's Connection