Class BaseProvider

constructor

• new BaseProvider(__namedParameters?: BaseProviderOpts): BaseProvider

  Parameters

  • __namedParameters: BaseProviderOpts = {}

  Returns BaseProvider

allowUnsafeEval

OptionalapiExtra

OptionalapiKey

apiUrl

apiUrlPlaceholder

baseLang

fetch

fetchOpts

headers

origin

originPlaceholder

detect

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

  Parameters

  • _text: string

  Returns Promise<DetectResponse>

getLangs

• getLangs(): Promise<GetLangsResponse>

  Returns Promise<GetLangsResponse>

getOpts

• getOpts(
      body: unknown,
      headers?: Record<string, string>,
      method?: RequestMethod,
  ): {
      body: unknown;
      headers: { Origin: string; Referer: string };
      method: RequestMethod;
  }

  Parameters

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

  Returns {
      body: unknown;
      headers: { Origin: string; Referer: string };
      method: RequestMethod;
  }

isSuccessProviderRes

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

  Type Parameters

  • T

  Parameters

  • res: ProviderResponse<T>

  Returns res is ProviderSuccessResponse<T>

isValidUrl

• isValidUrl(url: undefined | string): url is string

  Parameters

  • url: undefined | string

  Returns url is string

parseLang

• parseLang(lang: string): { fromLang: string; toLang: string }

  Parameters

  • lang: string

  Returns { fromLang: string; toLang: string }

request

• request<T = unknown>(
      path: string,
      body: unknown,
      headers?: Record<string, string>,
      method?: RequestMethod,
  ): Promise<ProviderResponse>

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

  Type Parameters

  • T = unknown

  Parameters

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

  Returns Promise<ProviderResponse>

translate

• translate(
      _text: string | string[],
      _lang?: string,
  ): Promise<TranslationResponse>

  Parameters

  • _text: string | string[]
  • _lang: string = "en-ru"

  Returns Promise<TranslationResponse>

updateData

• updateData(__namedParameters?: Partial<BaseProviderOpts>): void

  Parameters

  • __namedParameters: Partial<BaseProviderOpts> = {}

  Returns void