Skip to main content

ElasticSearchServiceParameters

@webda/elasticsearch

Class: ElasticSearchServiceParameters

Defined in: packages/elasticsearch/src/elasticsearch.service.ts:80

Parameters for ElasticSearchService

Extends​

  • ServiceParameters

Constructors​

Constructor​

new ElasticSearchServiceParameters(): ElasticSearchServiceParameters

Returns​

ElasticSearchServiceParameters

Inherited from​

ServiceParameters.constructor

Properties​

client​

client: any

Defined in: packages/elasticsearch/src/elasticsearch.service.ts:85

ClientOptions is not usable for now ts-json-schema error

indexes​

indexes: object

Defined in: packages/elasticsearch/src/elasticsearch.service.ts:89

Indexes to maintain, the key is the index name

Index Signature​

[key: string]: IndexParameter

type​

type: string

Defined in: packages/core/lib/services/serviceparameters.d.ts:8

Type of the service

Inherited from​

ServiceParameters.type

Methods​

load()​

load(params?): this

Defined in: packages/elasticsearch/src/elasticsearch.service.ts:96

Parameters​

params?​

any = {}

the raw parameters

Returns​

this

this

Overrides​

ServiceParameters.load

update()​

update(params, delta): this

Defined in: packages/core/lib/services/serviceparameters.d.ts:25

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update

with()​

with(callback): this

Defined in: packages/core/lib/services/serviceparameters.d.ts:31

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with