Class YandexTranslateProvider

constructor

• new YandexTranslateProvider(options?: BaseProviderOpts): YandexTranslateProvider

• Parameters

  • options: BaseProviderOpts = {}

  Returns YandexTranslateProvider

apiUrlPlaceholder

headers

MAX_UID

NANO_DIFF

originPlaceholder

session

sessionUrl

createSession

• createSession(): Promise<TranslationTypes.YandexTranslateProviderType.Session>

• Returns Promise<TranslationTypes.YandexTranslateProviderType.Session>

detect

• detect(text: string): Promise<DetectResponse>

• The total limit of characters per request is 1k chars

  Parameters

  • text: string

  Returns Promise<DetectResponse>

genYandexMetrikaUID

• genYandexMetrikaUID(): string

• Returns string

genYandexUID

• genYandexUID(): string

• Returns string

getLangs

• getLangs(): Promise<GetLangsResponse>

• Returns Promise<GetLangsResponse>

getOpts

• getOpts(
      body: null | URLSearchParams,
      headers?: Record<string, string>,
      method?: RequestMethod,
  ): {
      body: null | URLSearchParams;
      headers: {
          "Content-Type": string;
          Origin: string;
          Referer: string;
          "User-Agent": string;
      };
      method: RequestMethod;
  }

• Parameters

  • body: null | URLSearchParams
  • headers: Record<string, string> = {}
  • method: RequestMethod = "POST"

  Returns {
      body: null | URLSearchParams;
      headers: {
          "Content-Type": string;
          Origin: string;
          Referer: string;
          "User-Agent": string;
      };
      method: RequestMethod;
  }

getParams

• getParams(srv: Srv, params?: Record<string, string>): string

• Parameters

  • srv: Srv
  • params: Record<string, string> = {}

  Returns string

getSecure

• getSecure(srv: Srv): { srv: Srv; yu: string; yum: string }

• Parameters

  • srv: Srv

  Returns { srv: Srv; yu: string; yum: string }

getSession

• getSession(): Promise<TranslationTypes.YandexTranslateProviderType.Session>

• Returns Promise<TranslationTypes.YandexTranslateProviderType.Session>

isErrorRes

• isErrorRes<T extends object>(
      res: Response,
      data: TranslationTypes.YandexTranslateProviderType.FailedResponse | T,
  ): data is TranslationTypes.YandexTranslateProviderType.FailedResponse

• Type Parameters

  • T extends object

  Parameters

  • res: Response
  • data: TranslationTypes.YandexTranslateProviderType.FailedResponse | T

  Returns data is TranslationTypes.YandexTranslateProviderType.FailedResponse

isSuccessProviderRes

• isSuccessProviderRes<T>(
      res: ProviderResponse<T>,
  ): res is ProviderSuccessResponse<T>

• Type Parameters

  • T

  Parameters

  • res: ProviderResponse<T>

  Returns res is ProviderSuccessResponse<T>

rawDetect

• rawDetect(
      text: string,
      options?: DetectOptions,
  ): Promise<{ lang: string; probs: Record<string, number>; score: number }>

• You can use this method if you need a probabilities

  Parameters

  • text: string
  • options: DetectOptions = DetectOptions.withCurrentProb

  Returns Promise<{ lang: string; probs: Record<string, number>; score: number }>

rawTranslate

• rawTranslate(
      text: string | string[],
      lang?: string,
      options?: TranslateOptions,
      format?: "text" | "html",
  ): Promise<
      {
          align: undefined
          | string[];
          detected: undefined | Record<"lang", string>;
          lang: `${string}-${string}`;
          translations: string[];
      },
  >

• You can use this method if you need a detected language or align

  Parameters

  • text: string | string[]
  • lang: string = "en-ru"
  • options: TranslateOptions = TranslateOptions.default
  • format: "text" | "html" = "text"

  Returns Promise<
      {
          align: undefined
          | string[];
          detected: undefined | Record<"lang", string>;
          lang: `${string}-${string}`;
          translations: string[];
      },
  >

request

• request<T extends object>(
      path: string,
      body?: null | URLSearchParams,
      headers?: Record<string, string>,
      method?: RequestMethod,
  ): Promise<ProviderResponse<T>>

• The standard method for requesting the API, if necessary, you can override how it is done in the example

  Type Parameters

  • T extends object

  Parameters

  • path: string
  • body: null | URLSearchParams = null
  • headers: Record<string, string> = {}
  • method: RequestMethod = "POST"

  Returns Promise<ProviderResponse<T>>

translate

• translate(text: string | string[], lang?: string): Promise<TranslationResponse>

• The total limit of characters per request is 10k chars

  Parameters

  • text: string | string[]
  • lang: string = "en-ru"

  Returns Promise<TranslationResponse>