Class Dictionaries

Hierarchy

Index

Constructors

constructor

Methods

create

delete

  • delete(dictionaryID: GenericID): Promise<string>

edit

info

languageDelete

  • languageDelete(dictionaryID: GenericID, locale: string): Promise<string>

languageEdit

languageInfo

languageInfoBySlug

  • Get information about a dictionary querying by slug instead of the dictionary's ID.

    Parameters

    • slug: string

      Dictionary slug.

    • locale: string

      Language locale string (e.g. en-US).

    • Optional queryObj: LanguageInfoQuery

      Language info query params.

    Returns Promise<LanguageData>

list

  • Retrieve a list with all dictionaries from an account.

    default
    queryObj: {
      page: 1,
      fields: ["id", "name", "slug", "languages"],
      filter: {},
      amount: 20,
      orderBy: "name,asc",
    }
    

    Parameters

    Returns Promise<DictionaryInfo[]>