Class BaseLanguagesService

LanguagesService is a service in the Languages API that provides methods for fetching and manipulating languages data, including language codes and names in various formats. It helps to manage and maintain a list of available languages and their corresponding codes.

Index

Constructors

constructor

new BaseLanguagesService(): BaseLanguagesService
Returns BaseLanguagesService

Properties

`Protected` `Readonly`dataSource

dataSource: DataSource

`Protected`logger

logger: WinstonLogger

`Protected` `Readonly`loggerFactory

loggerFactory: WinstonLoggerFactory

Accessors

languagesRepository

get languagesRepository(): Repository<Language>
Returns Repository<Language>
- Defined in libs/core/src/modules/languages/languages.service.ts:40

Methods

`Protected`applyFilterToQuery

applyFilterToQuery(
query: SelectQueryBuilder<Language>,
filter: LanguagesFilter,
): void
Parameters
- query: SelectQueryBuilder<Language>
- filter: LanguagesFilter
Returns void
- Defined in libs/core/src/modules/languages/languages.service.ts:148

`Protected`applyOrderByToQuery

applyOrderByToQuery(
    query: SelectQueryBuilder<Language>,
    orderBy: LanguagesOrderBy,
    locale: string,
): Promise<void>
Parameters
- query: SelectQueryBuilder<Language>
- orderBy: LanguagesOrderBy
- locale: string
Returns Promise<void>
- Defined in libs/core/src/modules/languages/languages.service.ts:199

getMany

getMany(opts: FetchLanguagesOptions): Promise<[Language[], ListMeta]>
Fetch languages list
Parameters
- opts: FetchLanguagesOptions
  languages list options
Returns Promise<[Language[], ListMeta]>
languages list
- Defined in libs/core/src/modules/languages/languages.service.ts:110

getOne

getOne(code: string, locale?: string): Promise<MaybeNull<Language>>
Fetch language by code
Parameters
- code: string
  language code
- Optionallocale: string
  language locale
Returns Promise<MaybeNull<Language>>
- Defined in libs/core/src/modules/languages/languages.service.ts:88

getOneBy

getOneBy(__namedParameters: GetLanguageByOptions): Promise<MaybeNull<Language>>
Fetch language by options
Parameters
- __namedParameters: GetLanguageByOptions
Returns Promise<MaybeNull<Language>>
- Defined in libs/core/src/modules/languages/languages.service.ts:53

getOneByOrFail

getOneByOrFail(
opts: GetLanguageByOptions,
ctx: BaseServiceMethodContext,
): Promise<Language>
Parameters
- opts: GetLanguageByOptions
- ctx: BaseServiceMethodContext
Returns Promise<Language>
- Defined in libs/core/src/modules/languages/languages.service.ts:65

getOneOrFail

getOneOrFail(
    code: string,
    ctx: BaseServiceMethodContext,
    locale?: string,
): Promise<Language>
Fetch language by code or fail
Parameters
- code: string
- ctx: BaseServiceMethodContext
- Optionallocale: string
Returns Promise<Language>
- Defined in libs/core/src/modules/languages/languages.service.ts:98

isInScope

isInScope(code: string, scope: LanguagesScope): boolean
Check if language code is in the specified scope
Parameters
- code: string
  language code
- scope: LanguagesScope
  scope name
Returns boolean
true if language is in scope, false otherwise
- Defined in libs/core/src/modules/languages/languages.service.ts:191

onModuleInit

onModuleInit(): void
Returns void
- Defined in libs/core/src/modules/languages/languages.service.ts:44

Class BaseLanguagesService

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns BaseLanguagesService

Properties

Protected ReadonlydataSource

Protectedlogger

Protected ReadonlyloggerFactory

Accessors

languagesRepository

Returns Repository<Language>

Methods

ProtectedapplyFilterToQuery

Parameters

Returns void

ProtectedapplyOrderByToQuery

Parameters

Returns Promise<void>

getMany

Parameters

Returns Promise<[Language[], ListMeta]>

getOne

Parameters

Returns Promise<MaybeNull<Language>>

getOneBy

Parameters

Returns Promise<MaybeNull<Language>>

getOneByOrFail

Parameters

Returns Promise<Language>

getOneOrFail

Parameters

Returns Promise<Language>

isInScope

Parameters

Returns boolean

onModuleInit

Returns void

Settings

On This Page

`Protected` `Readonly`dataSource

`Protected`logger

`Protected` `Readonly`loggerFactory

`Protected`applyFilterToQuery

`Protected`applyOrderByToQuery