Class OCRClient

Hierarchy

  • default
    • OCRClient

Constructors

constructor

Properties

allowUnsafeEval apiExtra? apiKey? apiUrl apiUrlPlaceholder baseLang fetch fetchOpts headers MAX_UID NANO_DIFF ocrUrl origin originPlaceholder session? sessionUrl translateLang withTranslate

Methods

createSession detect genYandexMetrikaUID genYandexUID getLangs getOpts getParams getSecure getSession isErrorRes isSuccessProviderRes isValidUrl parseLang rawDetect rawTranslate request scanByBlob scanByFile scanByUrl translate updateData

Constructors

constructor

  • new OCRClient(params?: OCROpts): OCRClient

    If you don't want to use the classic fetch

    Example

    import { ofetch } from "ofetch";
    import OCRClient from "../dist/client";

    // https://github.com/unjs/ofetch
    const client = new OCRClient({
      fetchFn: ofetch.native,
    });

    const response = await client.scanByUrl(
      "https://repository-images.githubusercontent.com/450906609/c04b600b-5f0f-488b-820d-ffaeb1fde2d0",
    );

    console.log(response);

    Parameters

    Returns OCRClient

Properties

allowUnsafeEval

allowUnsafeEval: boolean

OptionalapiExtra

apiExtra?: unknown

OptionalapiKey

apiKey?: string

apiUrl

apiUrl: string

apiUrlPlaceholder

apiUrlPlaceholder: string

baseLang

baseLang: string

fetch

fetch: FetchFunction

fetchOpts

fetchOpts: Record<string, unknown>

headers

headers: { "Content-Type": string; "User-Agent": string }

MAX_UID

MAX_UID: number

NANO_DIFF

NANO_DIFF: number

ocrUrl

ocrUrl: string = "https://translate.yandex.net"

origin

origin: string

originPlaceholder

originPlaceholder: string

Optionalsession

session?: Session

sessionUrl

sessionUrl: string

translateLang

translateLang: string

withTranslate

withTranslate: boolean

Methods

createSession

  • createSession(): Promise<Session>

    Returns Promise<Session>

detect

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

    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<T = URLSearchParams>(
        body: null | T,
        headers?: Record<string, string>,
        method?: RequestMethod,
    ): {
        body: null | T;
        headers: {
            "Content-Type": string;
            Origin: string;
            Referer: string;
            "User-Agent": string;
        };
        method: RequestMethod;
    }

    Type Parameters

    • T = URLSearchParams

    Parameters

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

    Returns {
        body: null | T;
        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
    • Optionalparams: 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<Session>

    Returns Promise<Session>

isErrorRes

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

    Type Parameters

    • T extends object

    Parameters

    • res: Response
    • data: T | FailedResponse

    Returns data is FailedResponse

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 }

rawDetect

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

    Parameters

    • text: string
    • Optionaloptions: DetectOptions

    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[];
        },
    >

    Parameters

    • text: string | string[]
    • Optionallang: string
    • Optionaloptions: TranslateOptions
    • Optionalformat: "text" | "html"

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

request

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

    Type Parameters

    • T extends object
    • B = URLSearchParams

    Parameters

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

    Returns Promise<ProviderResponse<T>>

scanByBlob

scanByFile

scanByUrl

translate

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

    Parameters

    • text: string | string[]
    • Optionallang: string

    Returns Promise<TranslationResponse>

updateData

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

    Parameters

    • Optional__namedParameters: Partial<BaseProviderOpts>

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods