Class LangsHandler

Hierarchy

BaseHandler
- LangsHandler

Index

Constructors

constructor

new LangsHandler(logger: Logger): LangsHandler
Initializes a new instance of the BaseHandler class.
Parameters
- logger: Logger
  The logger instance.
Returns LangsHandler
Inherited from BaseHandler.constructor
- Defined in src/common/it/utils.ts:133

Properties

aliases

aliases: [
    string,
    (
        | "id"
        | "en-US"
        | "en-GB"
        | "bg"
        | "zh-CN"
        | "zh-TW"
        | "hr"
        | "cs"
        | "da"
        | "nl"
        | "fi"
        | "fr"
        | "de"
        | "el"
        | "hi"
        | "hu"
        | "it"
        | "ja"
        | "ko"
        | "lt"
        | "no"
        | "pl"
        | "pt-BR"
        | "ro"
        | "ru"
        | "es-ES"
        | "es-419"
        | "sv-SE"
        | "th"
        | "tr"
        | "uk"
        | "vi"
    )[],
][] = []

`Optional`defaultLang

defaultLang?: string

`Protected`logger

logger: Logger

The logger instance.

values

values: Partial<Record<string, any>> = {}

Methods

filter

filter(path: string): boolean
Parameters
- path: string
Returns boolean
Overrides BaseHandler.filter
- Defined in src/langs/handler.ts:10

get

get(
userLocale: string,
): __InternalParseLocale<DefaultLocale> & {
get(locale?: string): DefaultLocale;
}
Parameters
- userLocale: string
Returns __InternalParseLocale<DefaultLocale> & { get(locale?: string): DefaultLocale }
- Defined in src/langs/handler.ts:37

`Protected`getFiles

getFiles(dir: string): Promise<string[]>
Recursively retrieves all files in a directory.
Parameters
- dir: string
  The directory path.
Returns Promise<string[]>
A Promise that resolves to an array of file paths.
Inherited from BaseHandler.getFiles
- Defined in src/common/it/utils.ts:147

getKey

getKey(lang: string, message: string): undefined | string
Parameters
- lang: string
- message: string
Returns undefined | string
- Defined in src/langs/handler.ts:19

getLocale

getLocale(locale: string): string
Parameters
- locale: string
Returns string
- Defined in src/langs/handler.ts:15

load

load(dir: string): Promise<void>
Parameters
- dir: string
Returns Promise<void>
- Defined in src/langs/handler.ts:42

`Protected`loadFiles

loadFiles<T extends {}>(paths: string[]): Promise<T[]>
Loads files from given paths.
Type Parameters
- T extends {}
Parameters
- paths: string[]
  The paths of the files to load.
Returns Promise<T[]>
A Promise that resolves to an array of loaded files.
Inherited from BaseHandler.loadFiles
- Defined in src/common/it/utils.ts:166

`Protected`loadFilesK

loadFilesK<T>(
paths: string[],
): Promise<{ file: T; name: string; path: string }[]>
Loads files from given paths along with additional information.
Type Parameters
- T
Parameters
- paths: string[]
  The paths of the files to load.
Returns Promise<{ file: T; name: string; path: string }[]>
A Promise that resolves to an array of objects containing name, file, and path.
Inherited from BaseHandler.loadFilesK
- Defined in src/common/it/utils.ts:175

onFile

onFile(
locale: string,
__namedParameters: LangInstance,
): false | { file: Record<string, any>; locale: string }
Parameters
- locale: string
- __namedParameters: LangInstance
Returns false | { file: Record<string, any>; locale: string }
- Defined in src/langs/handler.ts:91

parse

parse(file: LangInstance): void
Parameters
- file: LangInstance
Returns void
- Defined in src/langs/handler.ts:49

reload

reload(lang: string): Promise<null | Record<string, any>>
Parameters
- lang: string
Returns Promise<null | Record<string, any>>
- Defined in src/langs/handler.ts:63

reloadAll

reloadAll(stopIfFail?: boolean): Promise<void>
Parameters
- stopIfFail: boolean = true
Returns Promise<void>
- Defined in src/langs/handler.ts:81

set

set(instances: LangInstance[]): void
Parameters
- instances: LangInstance[]
Returns void
- Defined in src/langs/handler.ts:57

Class LangsHandler

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LangsHandler

Properties

aliases

OptionaldefaultLang

Protectedlogger

values

Methods

filter

Parameters

Returns boolean

get

Parameters

Returns __InternalParseLocale<DefaultLocale> & { get(locale?: string): DefaultLocale }

ProtectedgetFiles

Parameters

Returns Promise<string[]>

getKey

Parameters

Returns undefined | string

getLocale

Parameters

Returns string

load

Parameters

Returns Promise<void>

ProtectedloadFiles

Type Parameters

Parameters

Returns Promise<T[]>

ProtectedloadFilesK

Type Parameters

Parameters

Returns Promise<{ file: T; name: string; path: string }[]>

onFile

Parameters

Returns false | { file: Record<string, any>; locale: string }

parse

Parameters

Returns void

reload

Parameters

Returns Promise<null | Record<string, any>>

reloadAll

Parameters

Returns Promise<void>

set

Parameters

Returns void

Settings

On This Page

`Optional`defaultLang

`Protected`logger

`Protected`getFiles

`Protected`loadFiles

`Protected`loadFilesK