Class OCRClient

Hierarchy

default
- OCRClient

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

params: OCROpts = {}

Returns OCRClient

Properties

allowUnsafeEval

allowUnsafeEval: boolean

`Optional`apiExtra

apiExtra?: unknown

`Optional`apiKey

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

`Optional`session

session?: Session

sessionUrl

sessionUrl: string

translateLang

translateLang: string

withTranslate

withTranslate: boolean

Methods

createSession

createSession(): Session
Returns Session
Inherited from YandexTranslateProvider.createSession
- Defined in node_modules/@toil/translate/dist/providers/yandextranslate.d.ts:25

detect

detect(text: string): Promise<DetectResponse>
Parameters
- text: string
Returns Promise<DetectResponse>
Inherited from YandexTranslateProvider.detect
- Defined in node_modules/@toil/translate/dist/providers/yandextranslate.d.ts:54

generateSid

generateSid(): string
Returns string
Inherited from YandexTranslateProvider.generateSid
- Defined in node_modules/@toil/translate/dist/providers/yandextranslate.d.ts:24

genYandexMetrikaUID

genYandexMetrikaUID(): string
Returns string
Inherited from YandexTranslateProvider.genYandexMetrikaUID
- Defined in node_modules/@toil/translate/dist/providers/yandextranslate.d.ts:18

genYandexUID

genYandexUID(): string
Returns string
Inherited from YandexTranslateProvider.genYandexUID
- Defined in node_modules/@toil/translate/dist/providers/yandextranslate.d.ts:17

getId

getId(): string
Returns string
Inherited from YandexTranslateProvider.getId
- Defined in node_modules/@toil/translate/dist/providers/yandextranslate.d.ts:26

getLangs

getLangs(): Promise<GetLangsResponse>
Returns Promise<GetLangsResponse>
Inherited from YandexTranslateProvider.getLangs
- Defined in node_modules/@toil/translate/dist/providers/yandextranslate.d.ts:55

getOpts

getOpts<T = URLSearchParams>(
    body: T | null,
    headers?: Record<string, string>,
    method?: RequestMethod,
): {
    body: T | null;
    headers: {
        "Content-Type": string;
        Origin: string;
        Referer: string;
        "User-Agent": string;
    };
    method: RequestMethod;
}
Type Parameters
- T = URLSearchParams
Parameters
- body: T | null
- headers: Record<string, string> = {}
- method: RequestMethod = "POST"
Returns {
    body: T | null;
    headers: {
        "Content-Type": string;
        Origin: string;
        Referer: string;
        "User-Agent": string;
    };
    method: RequestMethod;
}
Overrides YandexTranslateProvider.getOpts
- Defined in src/client.ts:43

getParams

getParams(srv: Srv, params?: Record<string, string>): string
Parameters
- srv: Srv
- Optionalparams: Record<string, string>
Returns string
Inherited from YandexTranslateProvider.getParams
- Defined in node_modules/@toil/translate/dist/providers/yandextranslate.d.ts:39

getSecure

getSecure(srv: Srv): { srv: Srv; yu: string; yum: string }
Parameters
- srv: Srv
Returns { srv: Srv; yu: string; yum: string }
Inherited from YandexTranslateProvider.getSecure
- Defined in node_modules/@toil/translate/dist/providers/yandextranslate.d.ts:19

getSession

getSession(): Session
Returns Session
Inherited from YandexTranslateProvider.getSession
- Defined in node_modules/@toil/translate/dist/providers/yandextranslate.d.ts:28

incrRequestsCount

incrRequestsCount(): void
Returns void
Inherited from YandexTranslateProvider.incrRequestsCount
- Defined in node_modules/@toil/translate/dist/providers/yandextranslate.d.ts:27

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
Overrides YandexTranslateProvider.isErrorRes
- Defined in src/client.ts:61

isSuccessProviderRes

isSuccessProviderRes<T>(
res: ProviderResponse<T>,
): res is ProviderSuccessResponse<T>
Type Parameters
- T
Parameters
- res: ProviderResponse<T>
Returns res is ProviderSuccessResponse<T>
Inherited from YandexTranslateProvider.isSuccessProviderRes
- Defined in node_modules/@toil/translate/dist/providers/base.d.ts:18

isValidUrl

isValidUrl(url: string | undefined): url is string
Parameters
- url: string | undefined
Returns url is string
Inherited from YandexTranslateProvider.isValidUrl
- Defined in node_modules/@toil/translate/dist/providers/base.d.ts:17

parseLang

parseLang(lang: string): { fromLang: string; toLang: string }
Parameters
- lang: string
Returns { fromLang: string; toLang: string }
Inherited from YandexTranslateProvider.parseLang
- Defined in node_modules/@toil/translate/dist/providers/base.d.ts:19

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 }>
Inherited from YandexTranslateProvider.rawDetect
- Defined in node_modules/@toil/translate/dist/providers/yandextranslate.d.ts:49

rawTranslate

rawTranslate(
    text: string | string[],
    lang?: string,
    options?: TranslateOptions,
    format?: "text" | "html",
): Promise<
    {
        align: string[]
        | undefined;
        detected: Record<"lang", string> | undefined;
        lang: `${string}-${string}`;
        translations: string[];
    },
>
Parameters
- text: string | string[]
- Optionallang: string
- Optionaloptions: TranslateOptions
- Optionalformat: "text" | "html"
Returns Promise<
    {
        align: string[]
        | undefined;
        detected: Record<"lang", string> | undefined;
        lang: `${string}-${string}`;
        translations: string[];
    },
>
Inherited from YandexTranslateProvider.rawTranslate
- Defined in node_modules/@toil/translate/dist/providers/yandextranslate.d.ts:42

request

request<T extends object, B = URLSearchParams>(
    path: string,
    body?: B | null,
    headers?: Record<string, string>,
    method?: RequestMethod,
): Promise<ProviderResponse<T>>
Type Parameters
- T extends object
- B = URLSearchParams
Parameters
- path: string
- body: B | null = null
- headers: Record<string, string> = {}
- method: RequestMethod = "POST"
Returns Promise<ProviderResponse<T>>
Overrides YandexTranslateProvider.request
- Defined in src/client.ts:72

scanByBlob

scanByBlob(data: Blob | File): Promise<OCRFullData>
Parameters
- data: Blob | File
Returns Promise<OCRFullData>
- Defined in src/client.ts:110

scanByFile

scanByFile(filepath: string): Promise<OCRFullData>
Parameters
- filepath: string
Returns Promise<OCRFullData>
- Defined in src/client.ts:190

scanByUrl

scanByUrl(url: string, headers?: Record<string, string>): Promise<OCRFullData>
Parameters
- url: string
- headers: Record<string, string> = {}
Returns Promise<OCRFullData>
- Defined in src/client.ts:224

translate

translate(text: string | string[], lang?: string): Promise<TranslationResponse>
Parameters
- text: string | string[]
- Optionallang: string
Returns Promise<TranslationResponse>
Inherited from YandexTranslateProvider.translate
- Defined in node_modules/@toil/translate/dist/providers/yandextranslate.d.ts:48

updateData

updateData(__namedParameters?: Partial<BaseProviderOpts>): void
Parameters
- Optional__namedParameters: Partial<BaseProviderOpts>
Returns void
Inherited from YandexTranslateProvider.updateData
- Defined in node_modules/@toil/translate/dist/providers/base.d.ts:16

Class OCRClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Example

Parameters

Returns OCRClient

Properties

allowUnsafeEval

OptionalapiExtra

OptionalapiKey

apiUrl

apiUrlPlaceholder

baseLang

fetch

fetchOpts

headers

MAX_UID

NANO_DIFF

ocrUrl

origin

originPlaceholder

Optionalsession

sessionUrl

translateLang

withTranslate

Methods

createSession

Returns Session

detect

Parameters

Returns Promise<DetectResponse>

generateSid

Returns string

genYandexMetrikaUID

Returns string

genYandexUID

Returns string

getId

Returns string

getLangs

Returns Promise<GetLangsResponse>

getOpts

Type Parameters

Parameters

Returns { body: T | null; headers: { "Content-Type": string; Origin: string; Referer: string; "User-Agent": string; }; method: RequestMethod;}

getParams

Parameters

Returns string

getSecure

Parameters

Returns { srv: Srv; yu: string; yum: string }

getSession

Returns Session

incrRequestsCount

Returns void

isErrorRes

Type Parameters

Parameters

Returns data is FailedResponse

isSuccessProviderRes

Type Parameters

Parameters

Returns res is ProviderSuccessResponse<T>

isValidUrl

Parameters

Returns url is string

parseLang

Parameters

Returns { fromLang: string; toLang: string }

rawDetect

Parameters

Returns Promise<{ lang: string; probs: Record<string, number>; score: number }>

rawTranslate

Parameters

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

`Optional`apiExtra

`Optional`apiKey

`Optional`session

Returns {
body: T | null;
headers: {
"Content-Type": string;
Origin: string;
Referer: string;
"User-Agent": string;
};
method: RequestMethod;
}

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