Class YandexBrowserProvider

constructor

• new YandexBrowserProvider(options?: BaseProviderOpts): YandexBrowserProvider

• Parameters

  • options: BaseProviderOpts = {}

  Returns YandexBrowserProvider

apiUrlPlaceholder

headers

originPlaceholder

srv

detect

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

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

  Parameters

  • text: string

  Returns Promise<DetectResponse>

getArrayParams

• getArrayParams(params: readonly [string, string][]): string

• Parameters

  • params: readonly [string, string][]

  Returns string

getLangs

• getLangs(): Promise<GetLangsResponse>

• Returns Promise<GetLangsResponse>

getOpts

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

• Parameters

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

  Returns {
      body: {};
      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

isErrorRes

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

• Type Parameters

  • T extends MinimalResponse = MinimalResponse

  Parameters

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

  Returns data is TranslationTypes.YandexTranslateProviderType.FailedResponse

isMinimalResponse

• isMinimalResponse(data: object): data is MinimalResponse

• Parameters

  • data: object

  Returns data is MinimalResponse

isSuccessProviderRes

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

• Type Parameters

  • T

  Parameters

  • res: ProviderResponse<T>

  Returns res is ProviderSuccessResponse<T>

request

• request<T extends object = MinimalResponse>(
      path: string,
      body?: unknown,
      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 = MinimalResponse

  Parameters

  • path: string
  • body: unknown = 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>