# TypeScript & JavaScript SDK

اثبتوا SDK وأجري بحثاً Node.js. Choose TypeScript or JavaScript; keep API key on the server.

مرجع كانوني: https://flashdata.dev/ar/docs/guides/flashdata-typescript
Reviewed: 2026-11-04 by FlashData

- [GitHub](https://github.com/flashdatadev/flashdata-typescript) — المصدر SDK المرجع المرجعي
- [احصل على مفتاح API](https://flashdata.dev/app/api-keys) — إنشاء مفتاح في الضمادات

<a id="application"></a>

## إجعلْك أولاً Node.js الطلب

ضع الطرد، وجهز الطرد API المفتاح والاختيار TypeScript أو JavaScript أسفل. أديري هذا الرمز على خادمك أو في نص محلي

- [SDK](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/api-reference.md)
- [npm](https://www.npmjs.com/package/@flashdata-dev/sdk/v/1.1.0)

<a id="install"></a>

### Install the SDK

وتستخدم هذه الأمثلة Node.js 22.18+ لتشغيل TypeScript مباشرة. ابدأ في ملف فارغ أو تختار المشروع الموجود إن كان لديك package.json.

#### المشروع الجديد

##### تثبيت

```bash
npm init -y
npm install --save-exact @flashdata-dev/sdk@1.1.0
```


#### المشروع القائم

##### تثبيت

```bash
npm install --save-exact @flashdata-dev/sdk@1.1.0
```


- [Install Node.js](https://nodejs.org/en/download)

<a id="key"></a>

### التوثيق

إنشاء مفتاح مع Google Search إذن أو إعادة استخدام مفتاح مرخص به المجموعة FLASHDATA_API_KEY في هذه المحطة باستخدام العجلة المخفية أسفل؛ تخطي هذا إذا كانت بيئتك توفره بالفعل.

فالمثال يمر بالمفتاح بشكل صريح. ملف (إنفي) لا يُحمل بواسطة هذه النصوص الحفاظ على المفتاح في تشكيلة جانب الخادم عند الاندماج في تطبيق على الشبكة.

#### Bash

##### مفتاح مخفي: Bash

```bash
# Bash: paste the key into a hidden prompt, not into this command.
read -r -s -p "FlashData API key: " FLASHDATA_API_KEY
printf '\n'
export FLASHDATA_API_KEY
```


#### PowerShell 7

##### مفتاح مخفي: PowerShell

```powershell
# PowerShell 7: paste the key into a hidden prompt.
$flashdataSecureKey = Read-Host "FlashData API key" -AsSecureString
$env:FLASHDATA_API_KEY = [System.Net.NetworkCredential]::new("", $flashdataSecureKey).Password
Remove-Variable flashdataSecureKey
```


- [التسجيل](https://flashdata.dev/signup)
- [فتح API Keys](https://flashdata.dev/app/api-keys)
- [Open Billing](https://flashdata.dev/app/billing)
- [تجربة العميل](https://flashdata.dev/ar/docs/guides/agent-onboarding/reference.md)

<a id="query"></a>

### نفّذ بحثًا

أنقذوا الملف المختار وأديروا قيادته في هذا المشروع وتقدم كل عملية بحثاً واحداً عن ما يصل إلى خمس نتائج. ويدار كلا الملفين مباشرة مع Node.js؛ ولا يلزم اتخاذ أي خطوة لبناء هذا المثال.

#### TypeScript

##### quickstart.mts

```typescript
import { FlashData, type GoogleSearchParams } from '@flashdata-dev/sdk';

const apiKey = process.env.FLASHDATA_API_KEY;
if (!apiKey) throw new Error('Set FLASHDATA_API_KEY in the server environment.');
const client = new FlashData({ apiKey });
const params: GoogleSearchParams = { num: 5 };
const response = await client.google.search({ query: 'battery recycling research', ...params });
if (response.status !== 'done') throw new Error(JSON.stringify(response));

for (const page of response.results) {
  for (const hit of page.organic ?? []) console.log(hit.title, hit.link);
}
console.log('Credits used:', response.usage.credits);
```

##### تشغيل؟ Node.js 22.18+

```bash
node quickstart.mts
```


#### JavaScript

##### quickstart.mjs

```javascript
import { FlashData } from '@flashdata-dev/sdk';

const apiKey = process.env.FLASHDATA_API_KEY;
if (!apiKey) throw new Error('Set FLASHDATA_API_KEY in the server environment.');
const client = new FlashData({ apiKey });
const response = await client.google.search({ query: 'battery recycling research', num: 5 });
if (response.status !== 'done') throw new Error(JSON.stringify(response));

for (const page of response.results) {
  for (const hit of page.organic ?? []) console.log(hit.title, hit.link);
}
console.log('Credits used:', response.usage.credits);
```

##### تشغيل

```bash
node quickstart.mjs
```



<a id="result"></a>

### تحقق من النتيجة

ويتم فحص النصوص ويطبع سندات المصدر، ورقم URLs، والائتمانات المستخدمة. النتائج العضوية فارغة صحيحة. ويبين الناتج المثالي الوارد أدناه الشكل؛ وستختلف المصادر الحية.

| الميدان | الاستخدام |
| --- | --- |
| results[].organic[] | عناوين Google Search وروابطه ومقتطفاته. للمصادر الأخرى حمولاتها ذات الأنواع الخاصة. |
| usage.credits | والائتمانات المحملة على هذا الطلب؛ وخمسة ضربات معدة هي طلب تفتيش واحد. |

#### الناتج المثالي

```text
Battery recycling research https://example.org/recycling
Credits used: 0.02
```


<a id="common-tasks"></a>

## جرب مصدر بيانات آخر

ويعمل كل تاب في كل من TypeScript و JavaScript. يستعاض عن الملف بالخطوة 3، والاحتفاظ ببطاقاته أو تمديده، وإدارة نفس القيادة. وكل ركض هو طلب جديد ويحتاج إلى إذن المصدر الموضح.

### Google News

الاحتياجات google_news. اقرأي بنود المادة في results[].news[].

#### quickstart.mts / quickstart.mjs

```typescript
import { FlashData } from '@flashdata-dev/sdk';

const apiKey = process.env.FLASHDATA_API_KEY;
if (!apiKey) throw new Error('Set FLASHDATA_API_KEY first.');
const client = new FlashData({ apiKey });
const response = await client.google.news({
  query: 'battery recycling', num: 5,
});
if (response.status !== 'done') throw new Error(JSON.stringify(response));
console.log(response);
```


### YouTube metadata

الاحتياجات youtube_metadata. Res titles, channels, duration and other video details.

#### quickstart.mts / quickstart.mjs

```typescript
import { FlashData } from '@flashdata-dev/sdk';

const apiKey = process.env.FLASHDATA_API_KEY;
if (!apiKey) throw new Error('Set FLASHDATA_API_KEY first.');
const client = new FlashData({ apiKey });
const response = await client.youtube.metadata({
  video_id: 'dQw4w9WgXcQ', include_formats: false,
});
if (response.status !== 'done') throw new Error(JSON.stringify(response));
console.log(response);
```


### مستنسخ YouTube

الاحتياجات youtube_transcript. يطلب مساراً آلياً إنجليزياً. أما النص في results[].fullText عندما يكون المسار متاحا.

#### quickstart.mts / quickstart.mjs

```typescript
import { FlashData } from '@flashdata-dev/sdk';

const apiKey = process.env.FLASHDATA_API_KEY;
if (!apiKey) throw new Error('Set FLASHDATA_API_KEY first.');
const client = new FlashData({ apiKey });
const response = await client.youtube.transcript({
  video_id: 'dQw4w9WgXcQ', language: 'en', auto: true,
});
if (response.status !== 'done') throw new Error(JSON.stringify(response));
console.log(response);
```


- [جميع بارامترات المصدر](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/sources/index.md)

<a id="typecheck"></a>

## (أ) مشروع TypeScript

(نود) يدير هذا المثال عن طريق التعري (ج) التحقق من الأنواع دون إرسال طلب، وتركيب شركة TypeScript، وإدارة المجمع مع شركة --noEmit:

### الشيك من النوع الاختياري

```bash
npm install --save-dev typescript@~5.9.3 @types/node@^22
npx tsc quickstart.mts --module nodenext --target es2022 --strict --noEmit
```

- [Node.js TypeScript](https://nodejs.org/api/typescript.html)

<a id="features"></a>

## ما هذا؟ SDK الدعم

| الاستخدام | الطرائق |
| --- | --- |
| google / youtube | البحث والاسترجاع البيانات المنظمة مع أجهزة مساعدة المصدر المطبوع. إعادة استخدام عميل واحد في خدمتك. |
| youtube.download | تسليم الصوت أو الفيديو إلى مخزن السحابة الخاص بك من خلال وظيفة خلفية. (ب) يتطلب إذناً وتخزيناً من طراز youtube_download. |
| jobs / bulk | وقدمت شركة " سافي " (IDs) وسترد النتائج المنجزة، وهي تنتظر الانتظار في JavaScript؛ وتقدم شركة mode: 'async' وظيفة خلفية إلى جانب الخادم. |
| account | اقرأوا الولوج، والتوازن، والتسعير، والحدود، والاستخدام قبل العمل المتكرر. |
| respondWith / accept | مرّة { respondWith: 'markdown' } كحجة الطريقة الثانية Markdown في response.contentأو { accept: 'text/plain' } من أجل الخيط الأجسام JSON هي التخلف. |

- [مثال على الحمولة](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/examples/youtube_download.mjs)
- [معدات التخزين](https://flashdata.dev/ar/docs/guides/youtube-download-guide/reference.md)
- [تنسيقات الاستجابة](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/response-formats.md)

<a id="next"></a>

## الخطوات التالية

- [إنقاذ النتائج ومعالجة الأخطاء](https://flashdata.dev/ar/docs/guides/sdk-operations/reference.md)
- [الوظائف والدفعات](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/jobs.md)
- [تشكيلة العملاء](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/client.md)
- [SDK](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/api-reference.md)

<a id="errors"></a>

## إذا فشلت خطوة

| المشكلة | Fix |
| --- | --- |
| الحزمة أو الإجازات المفقودة | تحقق من العقدة --version و install @flashdata-dev/sdk في هذا المشروع. أبقوا الـ "ميتس" أو "مج" تمددهم موضحاً أعلاه |
| 401 / FLASHDATA_API_KEY | ضع مفتاحاً صالحاً في المحطة حيث تدير المثال |
| 403 | Enable Google Search for this API key. |
| 402 | تحقق من شركة Billing فيما يتعلق بالائتمانات المتاحة، أو تدّعي تجربة عميل مستنفد. |
| 429 | انتظر Retry-Afterثم خفض معدل طلبك. |
| الوقت أو خطأ الخادم | تحقق History وقبل الإلغاء؛ قد يكون الطلب الأول قد بدأ بالفعل. |

- [التاريخ](https://flashdata.dev/app/jobs)
- [Billing](https://flashdata.dev/app/billing)
- [SDK الأخطاء والانتعاش](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/errors.md)
