Skip to content

Class: default

client/apis/LocaleAPI.default

Hierarchy

↳ default

Table of contents

Constructors

Properties

Methods

Constructors

constructor

+ new default(client: default): default

Parameters:

Name Type
client default

Returns: default

Inherited from: default

Defined in: client/apis/LocaleAPI.ts:55

Properties

client

• client: default

Inherited from: default.client

Defined in: client/apis/BaseAPI.ts:25

options

• options: BaseAPIOptions

Inherited from: default.options

Defined in: client/apis/BaseAPI.ts:26

Methods

getCountryRegions

▸ getCountryRegions(options: GetCountryRegionsOptions): Promise<GetCountryRegions>

Parameters:

Name Type
options GetCountryRegionsOptions

Returns: Promise<GetCountryRegions>

Defined in: client/apis/LocaleAPI.ts:63

getLocales

▸ getLocales(options: GetLocalesOptions): Promise<GetLocales>

Parameters:

Name Type
options GetLocalesOptions

Returns: Promise<GetLocales>

Defined in: client/apis/LocaleAPI.ts:75

getLocusSupportedLocales

▸ getLocusSupportedLocales(): Promise<GetLocusSupportedLocales>

Returns: Promise<GetLocusSupportedLocales>

Defined in: client/apis/LocaleAPI.ts:109

getSupportedLocales

▸ getSupportedLocales(): Promise<GetSupportedLocales>

Returns: Promise<GetSupportedLocales>

Defined in: client/apis/LocaleAPI.ts:87

getUserLocale

▸ getUserLocale(): Promise<GetUserLocale>

Returns: Promise<GetUserLocale>

Defined in: client/apis/LocaleAPI.ts:98

request

▸ request(options: BaseAPIRequestOptions): Promise<RESTResponseDataType>

Parameters:

Name Type
options BaseAPIRequestOptions

Returns: Promise<RESTResponseDataType>

Inherited from: default

Defined in: client/apis/BaseAPI.ts:33

setUserLocale

▸ setUserLocale(options: SetUserLocaleOptions): Promise<SetUserLocale>

Parameters:

Name Type
options SetUserLocaleOptions

Returns: Promise<SetUserLocale>

Defined in: client/apis/LocaleAPI.ts:120