Class Dictionaries

Dictionaries allow you to create a storage of words that should be skipped by the spell checker.

Use API to get the list of organization dictionaries and to edit a specific dictionary.

Hierarchy (view full)

CrowdinApi
- Dictionaries

Index

Constructors

Methods

editDictionary graphql listDictionaries withFetchAll

Constructors

constructor

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

Methods

editDictionary

editDictionary(projectId, languageId, request): Promise<ResponseObject<Dictionary>>
Parameters
- projectId: number
  project identifier
- languageId: string
  language identifier
- request: PatchRequest[]
  request body
Returns Promise<ResponseObject<Dictionary>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.dictionaries.patch
- Defined in dictionaries/index.ts:43

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

listDictionaries

listDictionaries(projectId, options?): Promise<ResponseList<Dictionary>>
Parameters
- projectId: number
  project identifier
- Optionaloptions: ListDictionariesOptions
  optional parameters for listing dictionaries
Returns Promise<ResponseList<Dictionary>>
See
https://developer.crowdin.com/api/v2/#operation/api.projects.dictionaries.getMany
- Defined in dictionaries/index.ts:14
listDictionaries(projectId, languageIds?): Promise<ResponseList<Dictionary>>
Parameters
- projectId: number
  project identifier
- OptionallanguageIds: string
  filter progress by Language Identifiers
Returns Promise<ResponseList<Dictionary>>
Deprecated
optional parameters should be passed through an object

See
https://developer.crowdin.com/api/v2/#operation/api.projects.dictionaries.getMany
- Defined in dictionaries/index.ts:24

withFetchAll

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