Class MSEdgeTranslateProvider

constructor

• new MSEdgeTranslateProvider(options?: BaseProviderOpts): MSEdgeTranslateProvider

• Parameters

  • options: BaseProviderOpts = {}

  Returns MSEdgeTranslateProvider

apiUrlPlaceholder

headers

originPlaceholder

session

sessionUrl

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 50k chars

  Parameters

  • text: string

  Returns Promise<DetectResponse>

getLangs

• getLangs(): Promise<GetLangsResponse>

• Returns Promise<GetLangsResponse>

getOpts

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

• Parameters

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

  Returns {
      body: null | string;
      headers: {
          "Content-Type": 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.MSEdgeProviderType.Session>

• Returns Promise<TranslationTypes.MSEdgeProviderType.Session>

isErrorRes

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

• Type Parameters

  • T extends object

  Parameters

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

  Returns data is TranslationTypes.MSEdgeProviderType.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 | string[],
  ): Promise<
      {
          isTranslationSupported: boolean;
          isTransliterationSupported: boolean;
          language: string;
          score: number;
      }[],
  >

• You can use this method if you need a multi detect

  Parameters

  • text: string | string[]

  Returns Promise<
      {
          isTranslationSupported: boolean;
          isTransliterationSupported: boolean;
          language: string;
          score: number;
      }[],
  >

rawTranslate

• rawTranslate(
      text: string | string[],
      lang?: string,
      profanityAction?: ProfanityAction,
      textType?: "html" | "plain",
  ): Promise<RawTranslateResponse>

• You can use this method if you need set a profanity

  Parameters

  • text: string | string[]
  • lang: string = "en-ru"
  • profanityAction: ProfanityAction = ProfanityAction.NoAction
  • textType: "html" | "plain" = "plain"

  Returns Promise<RawTranslateResponse>

request

• request<T extends object>(
      path: string,
      body?: null | string,
      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 | string = 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 50k chars

  Parameters

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

  Returns Promise<TranslationResponse>