Class Languages

Crowdin supports more than 300 world languages and custom languages created in the system.

Use API to get the list of all supported languages and retrieve additional details (e.g. text direction, internal code) on specific language.

Hierarchy (view full)

CrowdinApi
- Languages

Index

Constructors

constructor

Methods

addCustomLanguage deleteCustomLanguage editCustomLanguage getLanguage graphql listSupportedLanguages withFetchAll

Constructors

constructor

new Languages(credentials, config?): Languages
Parameters
- credentials: Credentials
  credentials
- Optionalconfig: ClientConfig
  optional configuration of the client
Returns Languages
Inherited from CrowdinApi.constructor
- Defined in core/index.ts:224

Methods

addCustomLanguage

addCustomLanguage(request): Promise<ResponseObject<Language>>
Parameters
- request: AddLanguageRequest
  request body
Returns Promise<ResponseObject<Language>>
See
https://developer.crowdin.com/api/v2/#operation/api.languages.post
- Defined in languages/index.ts:36

deleteCustomLanguage

deleteCustomLanguage(languageId): Promise<void>
Parameters
- languageId: string
  language identifier
Returns Promise<void>
See
https://developer.crowdin.com/api/v2/#operation/api.languages.delete
- Defined in languages/index.ts:54

editCustomLanguage

editCustomLanguage(languageId, request): Promise<ResponseObject<Language>>
Parameters
- languageId: string
  language identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<Language>>
See
https://developer.crowdin.com/api/v2/#operation/api.languages.patch
- Defined in languages/index.ts:64

getLanguage

getLanguage(languageId): Promise<ResponseObject<Language>>
Parameters
- languageId: string
  language identifier
Returns Promise<ResponseObject<Language>>
See
https://developer.crowdin.com/api/v2/#operation/api.languages.get
- Defined in languages/index.ts:45

graphql

graphql<T>(req): Promise<ResponseObject<T>>
Type Parameters
- T
Parameters
- req: {
      operationName?: string;
      query: string;
      variables?: any;
  }
  - OptionaloperationName?: string
  - query: string
  - Optionalvariables?: any
Returns Promise<ResponseObject<T>>
Inherited from CrowdinApi.graphql
- Defined in core/index.ts:258

listSupportedLanguages

listSupportedLanguages(options?): Promise<ResponseList<Language>>
Parameters
- Optionaloptions: Partial<Pagination>
  optional pagination parameters for the request
Returns Promise<ResponseList<Language>>
See
https://developer.crowdin.com/api/v2/#operation/api.languages.getMany
- Defined in languages/index.ts:13
listSupportedLanguages(limit?, offset?): Promise<ResponseList<Language>>
Parameters
- Optionallimit: number
  maximum number of items to retrieve (default 25)
- Optionaloffset: number
  starting offset in the collection (default 0)
Returns Promise<ResponseList<Language>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.languages.getMany
- Defined in languages/index.ts:20

withFetchAll

withFetchAll(maxLimit?): this
Parameters
- OptionalmaxLimit: number
Returns this
Inherited from CrowdinApi.withFetchAll
- Defined in core/index.ts:313

Class Languages

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Languages

Methods

addCustomLanguage

Parameters

Returns Promise<ResponseObject<Language>>

See

deleteCustomLanguage

Parameters

Returns Promise<void>

See

editCustomLanguage

Parameters

Returns Promise<ResponseObject<Language>>

See

getLanguage

Parameters

Returns Promise<ResponseObject<Language>>

See

graphql

Type Parameters

Parameters

OptionaloperationName?: string

query: string

Optionalvariables?: any

Returns Promise<ResponseObject<T>>

listSupportedLanguages

Parameters

Returns Promise<ResponseList<Language>>

See

Parameters

Returns Promise<ResponseList<Language>>

Deprecated

See

withFetchAll

Parameters

Returns this

Settings

On This Page

`Optional`operationName?: string

`Optional`variables?: any