Types
This module contains the types used in the Crowdin OTA Client.
Interfaces
ClientConfig
Defined in: model.ts:7
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
httpClient? | HttpClient | Specify your own http client. Default uses fetch | model.ts:11 |
disableManifestCache? | boolean | Disable cache of distribution manifest. Default is false | model.ts:15 |
languageCode? | string | Default language code to be used if language was not passed as an input argument of the method | model.ts:19 |
disableStringsCache? | boolean | Disable translation strings cache. Default is false | model.ts:23 |
disableLanguagesCache? | boolean | Disable Crowdin languages cache. Default is false | model.ts:27 |
disableJsonDeepMerge? | boolean | Disable deep merge and use shallow merge to merge translation strings from json file | model.ts:31 |
enterpriseOrganizationDomain? | string | The name of your Crowdin Enterprise organization If provided, this will fetch languages from the Enterprise API instead of the Crowdin API v2. The name must be a valid Enterprise organization name. | model.ts:36 |
HttpClient
Defined in: model.ts:39
Methods
get()
get<
T>(url):Promise<T>
Defined in: model.ts:45
Executes HTTP GET request
Type Parameters
| Type Parameter |
|---|
T |
Parameters
| Parameter | Type | Description |
|---|---|---|
url | string | http url |
Returns
Promise<T>
Manifest
Defined in: model.ts:48
Properties
| Property | Type | Defined in |
|---|---|---|
files | string[] | model.ts:49 |
languages | string[] | model.ts:50 |
timestamp | number | model.ts:51 |
language_mapping | never[] | LanguageMappings | model.ts:53 |
custom_languages | never[] | CustomLanguages | model.ts:54 |
content | object | model.ts:55 |
mapping | string[] | model.ts:58 |
LanguageMappings
Defined in: model.ts:61
Indexable
[languageCode: string]: LanguageMapping
CustomLanguages
Defined in: model.ts:65
Indexable
[languageCode: string]: CustomLanguageRaw
LanguageMapping
Defined in: model.ts:69
Indexable
[placeholder: string]: string
Translations
Defined in: model.ts:73
Indexable
[languageCode: string]: LanguageTranslations[]
LanguageTranslations
Defined in: model.ts:77
Properties
| Property | Type | Defined in |
|---|---|---|
file | string | model.ts:78 |
content | any | model.ts:79 |
LanguageFiles
Defined in: model.ts:82
Indexable
[languageCode: string]: string[]
LanguageStrings
Defined in: model.ts:86
Indexable
[languageCode: string]: any
CustomLanguageRaw
Defined in: model.ts:90
Properties
| Property | Type | Defined in |
|---|---|---|
name | string | model.ts:91 |
two_letters_code | string | model.ts:92 |
three_letters_code | string | model.ts:93 |
locale | string | model.ts:94 |
locale_with_underscore | string | model.ts:95 |
android_code | string | model.ts:96 |
osx_code | string | model.ts:97 |
osx_locale | string | model.ts:98 |