Class LangClient

Hierarchy

CoreClient<ICoreKernel<any>, LangDb, LangClient, null, null>
- LangClient

Index

Constructors

constructor

new LangClient(
    module: ICoreKernelModule<
        ICoreKernel<any, ICoreAnyModule>,
        LangDb,
        LangClient,
        null,
        null,
    >,
): LangClient
Parameters
- module: ICoreKernelModule<
      ICoreKernel<any, ICoreAnyModule>,
      LangDb,
      LangClient,
      null,
      null,
  >
Returns LangClient
Inherited from CoreClient< ICoreKernel<any>, LangDb, LangClient, null, null >.constructor
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:672

Properties

`Protected`channel

channel: string

logger

logger: CoreLogger | null

`Static`DEFAULT_LANG_DB_KEY

DEFAULT_LANG_DB_KEY: string = 'lang'

`Static`STORE_TRANSLATION_PATH

STORE_TRANSLATION_PATH: string = 'GLX_TRANSLATION_PATH'

Methods

debug

debug(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from CoreClient.debug
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:221

error

error(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from CoreClient.error
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:223

getAllTranslation

getAllTranslation(): Promise<Translation[]>
Returns Promise<Translation[]>
- Defined in src/client/LangClient.ts:25

getCClient

getCClient<X extends ICoreCClient>(): X
Type Parameters
- X extends ICoreCClient
Returns X
Inherited from CoreClient.getCClient
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:255

getConfigStore

getConfigStore(): IStore
Returns IStore
Inherited from CoreClient.getConfigStore
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:254

getCur

getCur(scopes?: string[]): Promise<LangData | null>
Parameters
- Optionalscopes: string[]
Returns Promise<LangData | null>
- Defined in src/client/LangClient.ts:79

getCurTranslator

getCurTranslator(scopes?: string[]): Promise<GLang>
Parameters
- Optionalscopes: string[]
Returns Promise<GLang>
- Defined in src/client/LangClient.ts:93

getDbLang

getDbLang(): Promise<string>
Returns Promise<string>
- Defined in src/client/LangClient.ts:174

getDefault

getDefault(scopes?: string[]): Promise<LangData | undefined>
Parameters
- Optionalscopes: string[]
Returns Promise<LangData | undefined>
- Defined in src/client/LangClient.ts:75

getKernel

getKernel(): ICoreKernel
Returns ICoreKernel
Inherited from CoreClient.getKernel
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:252

getLang

getLang(code: string, scopes?: string[]): Promise<LangData | undefined>
Parameters
- code: string
- Optionalscopes: string[]
Returns Promise<LangData | undefined>
- Defined in src/client/LangClient.ts:37

getLangList

getLangList(): Promise<{ code: string; label: string }[]>
Returns Promise<{ code: string; label: string }[]>
- Defined in src/client/LangClient.ts:97

getModule

getModule(): ICoreKernelModule<
    ICoreKernel<any, ICoreAnyModule>,
    LangDb,
    LangClient,
    null,
    null,
>
Returns ICoreKernelModule<
    ICoreKernel<any, ICoreAnyModule>,
    LangDb,
    LangClient,
    null,
    null,
>
Inherited from CoreClient.getModule
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:253

getName

getName(): string
Returns string
Inherited from CoreClient.getName
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:227

hasLang

hasLang(code: string): Promise<boolean>
Parameters
- code: string
Returns Promise<boolean>
- Defined in src/client/LangClient.ts:21

info

info(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from CoreClient.info
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:222

lError

lError(message: string): Error
Parameters
- message: string
Returns Error
Inherited from CoreClient.lError
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:226

loadLangFromFolder

loadLangFromFolder(path: string): Promise<void>
Parameters
- path: string
Returns Promise<void>
- Defined in src/client/LangClient.ts:106

log

log(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from CoreClient.log
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:220

setDbLang

setDbLang(lang: string): Promise<void>
Parameters
- lang: string
Returns Promise<void>
- Defined in src/client/LangClient.ts:165

setLogger

setLogger(logger: CoreLogger): void
Parameters
- logger: CoreLogger
Returns void
Inherited from CoreClient.setLogger
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:219

verbose

verbose(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from CoreClient.verbose
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:225

warn

warn(...ags: unknown[]): void
Parameters
- ...ags: unknown[]
Returns void
Inherited from CoreClient.warn
- Defined in node_modules/@grandlinex/core/dist/CoreKernel-OqPboNJt.d.mts:224

Class LangClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LangClient

Properties

Protectedchannel

logger

StaticDEFAULT_LANG_DB_KEY

StaticSTORE_TRANSLATION_PATH

Methods

debug

Parameters

Returns void

error

Parameters

Returns void

getAllTranslation

Returns Promise<Translation[]>

getCClient

Type Parameters

Returns X

getConfigStore

Returns IStore

getCur

Parameters

Returns Promise<LangData | null>

getCurTranslator

Parameters

Returns Promise<GLang>

getDbLang

Returns Promise<string>

getDefault

Parameters

Returns Promise<LangData | undefined>

getKernel

Returns ICoreKernel

getLang

Parameters

Returns Promise<LangData | undefined>

getLangList

Returns Promise<{ code: string; label: string }[]>

getModule

Returns ICoreKernelModule< ICoreKernel<any, ICoreAnyModule>, LangDb, LangClient, null, null,>

getName

Returns string

hasLang

Parameters

Returns Promise<boolean>

info

Parameters

Returns void

lError

Parameters

Returns Error

loadLangFromFolder

Parameters

Returns Promise<void>

log

Parameters

Returns void

setDbLang

Parameters

Returns Promise<void>

setLogger

Parameters

Returns void

verbose

Parameters

Returns void

warn

Parameters

Returns void

Settings

On This Page

`Protected`channel

`Static`DEFAULT_LANG_DB_KEY

`Static`STORE_TRANSLATION_PATH

Returns ICoreKernelModule<
ICoreKernel<any, ICoreAnyModule>,
LangDb,
LangClient,
null,
null,
>