Skip to main content

@webda/coreReadme | API


Class: AggregatorParameters

Mapper configuration

Extends

Constructors

new AggregatorParameters(params)

new AggregatorParameters(params): AggregatorParameters

Parameters

params: any

Returns

AggregatorParameters

Overrides

MapperParameters.constructor

Source

packages/core/src/stores/aggregator.ts:10

Properties

async

async: boolean

Async

Default

false

Inherited from

MapperParameters.async

Source

packages/core/src/stores/mapper.ts:33


attribute

attribute: string

Attribute to use for link

Depending on the type

  • string[]: will consider each string as id
  • string: will be consider as id
  • Object: each keys will be consider as id

Inherited from

MapperParameters.attribute

Source

packages/core/src/stores/mapper.ts:42


cascade

cascade: boolean

Delete source if target object is deleted

Inherited from

MapperParameters.cascade

Source

packages/core/src/stores/mapper.ts:50


fields

fields: string[]

Field to duplicate

Inherited from

MapperParameters.fields

Source

packages/core/src/stores/mapper.ts:19


key

key: string

Default

index

Source

packages/core/src/stores/aggregator.ts:8


openapi?

openapi?: OpenAPIWebdaDefinition

OpenAPI override

Schema Ignore

Inherited from

MapperParameters.openapi

Source

packages/core/src/services/service.ts:260


source

source: string

Source service

Inherited from

MapperParameters.source

Source

packages/core/src/stores/mapper.ts:23


target

target: string

Target store

Inherited from

MapperParameters.target

Source

packages/core/src/stores/mapper.ts:27


targetAttribute

targetAttribute: string

The object will contain a Mapper

Inherited from

MapperParameters.targetAttribute

Source

packages/core/src/stores/mapper.ts:46


type

type: string

Type of the service

Inherited from

MapperParameters.type

Source

packages/core/src/services/service.ts:251


url?

url?: string

URL on which to serve the content

Inherited from

MapperParameters.url

Source

packages/core/src/services/service.ts:255