Class LibreTranslateProvider

constructor

• new LibreTranslateProvider(options?: BaseProviderOpts): LibreTranslateProvider

  Parameters

  • options: BaseProviderOpts = {}

  Returns LibreTranslateProvider

apiUrlPlaceholder

headers

originPlaceholder

Optionalsession

createSession

• createSession(): Promise<
      { creationTimestamp: number; maxAge: number; token: string },
  >

  Returns Promise<{ creationTimestamp: number; maxAge: number; token: string }>

detect

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

  The total limit of characters per request is 2k chars

  Parameters

  • text: string

  Returns Promise<DetectResponse>

getLangs

• getLangs(): Promise<GetLangsResponse>

  Returns Promise<GetLangsResponse>

getOpts

• getOpts(
      body?: FormData,
      headers?: Record<string, string>,
      method?: RequestMethod,
  ): {
      body: undefined | FormData;
      headers: {
          Cookie: string;
          Origin: string;
          Referer: string;
          "User-Agent": string;
      };
      method: RequestMethod;
  }

  Parameters

  • Optionalbody: FormData
  • headers: Record<string, string> = {}
  • method: RequestMethod = "POST"

  Returns {
      body: undefined | FormData;
      headers: {
          Cookie: string;
          Origin: string;
          Referer: string;
          "User-Agent": string;
      };
      method: RequestMethod;
  }

getParams

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

  Parameters

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

  Returns string

getSession

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

  Returns Promise<TranslationTypes.LibreTranslateProviderType.Session>

isErrorRes

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

  Type Parameters

  • T extends object

  Parameters

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

  Returns data is TranslationTypes.LibreTranslateProviderType.FailedResponse

rawTranslate

• rawTranslate(
      text: string | string[],
      lang?: string,
  ): Promise<TranslationTypes.LibreTranslateProviderType.RawTranslateResponse>

  Parameters

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

  Returns Promise<TranslationTypes.LibreTranslateProviderType.RawTranslateResponse>

request

• request<T extends object>(
      path: string,
      body?: FormData,
      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
  • Optionalbody: FormData
  • 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 2k chars

  Parameters

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

  Returns Promise<TranslationResponse>