Skip to content

@sourceloop/search-service / Exports / SearchServiceComponent

Class: SearchServiceComponent<T>

Type parameters

Name Type
T extends Model

Implements

  • Component

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new SearchServiceComponent<T>(application, config)

Type parameters

Name Type
T extends Model<T>

Parameters

Name Type
application RestApplication
config SearchServiceConfig<T>

Defined in

services/search-service/src/component.ts:55

Properties

application

Private Readonly application: RestApplication

Defined in

services/search-service/src/component.ts:57


bindings

bindings: Binding<any>[] = []

Implementation of

Component.bindings

Defined in

services/search-service/src/component.ts:171


config

Private Readonly config: SearchServiceConfig<T>

Defined in

services/search-service/src/component.ts:59


controllers

Optional controllers: ControllerClass<any>[]

An array of controller classes

Implementation of

Component.controllers

Defined in

services/search-service/src/component.ts:188


models

Optional models: Class<Model>[]

An optional list of Model classes to bind for dependency injection via app.model() API.

Defined in

services/search-service/src/component.ts:183


providers

providers: ProviderMap = {}

Implementation of

Component.providers

Defined in

services/search-service/src/component.ts:169


repositories

Optional repositories: Class<Repository<Model>>[]

An optional list of Repository classes to bind for dependency injection via app.repository() API.

Defined in

services/search-service/src/component.ts:177

Methods

_configureProvidersAndRepositories

Private _configureProvidersAndRepositories(): void

The function _configureProvidersAndRepositories sets up providers and repositories based on the configuration for using Sequelize in a TypeScript application.

Returns

void

Defined in

services/search-service/src/component.ts:92


_setupSearchController

Private _setupSearchController(): void

The function _setupSearchController sets up a search controller based on configuration settings.

Returns

void

If the condition if (!this.config) is true, then the function will return early and nothing will be executed beyond that point.

Defined in

services/search-service/src/component.ts:117


createResultModel

createResultModel(base, models): typeof Model

Parameters

Name Type
base typeof Model
models string[]

Returns

typeof Model

Defined in

services/search-service/src/component.ts:221


getSearchableModelIdentifiers

getSearchableModelIdentifiers(config): string[]

Parameters

Name Type
config SearchServiceConfig<T>

Returns

string[]

Defined in

services/search-service/src/component.ts:159


setupSequence

setupSequence(): void

Setup ServiceSequence by default if no other sequnce provided

Returns

void

Defined in

services/search-service/src/component.ts:196