# TypeScript & JavaScript SDK

Anstal SDK dan jalankan pencarian di Node.js. Pilih TypeScript atau JavaScript; tetap kunci API pada server.

Referensi boonical: https://flashdata.dev/ms/docs/guides/flashdata-typescript
Diulas: 2026-11-04 oleh FlashData

- [GitHub](https://github.com/flashdatadev/flashdata-typescript) — Referensi Sumber dan SDK
- [Dapatkan kunci API](https://flashdata.dev/app/api-keys) — konsol ini akan menciptakan kunci

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

## Buat permintaan Node.js pertamamu

Pasang paket, set kunci API dan pilih TypeScript atau JavaScript di bawah. Jalankan kode ini pada server Anda atau dalam skrip lokal.

- [Referensi metode 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>

### Pasang SDK

Contoh-contoh ini menggunakan Node.js 22.18+ untuk menjalankan TypeScript secara langsung. Mulai pada folder kosong, atau pilih Projek Exexist jika Anda memiliki package.json.

#### Projek projek baru

##### Pasang

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


#### Projek projek wujud

##### Pasang

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


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

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

### Autentifikasi

Aaux membuat kunci dengan izin Google Search atau menggunakan kembali kunci yang berwenang. Andikario Set FLASHDATA_API_KEY di terminal ini menggunakan prompt tersembunyi di bawah; lewati ini jika lingkungan Anda sudah memasoknya.

Contoh ini melewati kunci secara eksplisit. Sebuah berkas .env tidak dimuat oleh skrip ini. ¡Keep the key dalam konfigurasi sisi-server ketika mengintegrasikan ke dalam aplikasi web.

#### Bash

##### Prompt kunci tersembunyi · 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

##### Prompt kunci tersembunyi · 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
```


- [Daftar](https://flashdata.dev/signup)
- [Buka API Keys](https://flashdata.dev/app/api-keys)
- [Open Billing](https://flashdata.dev/app/billing)
- [Percobaan agen agen percobaan](https://flashdata.dev/ms/docs/guides/agent-onboarding/reference.md)

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

### Jalankan carian

Simpan berkas yang dipilih dan jalankan perintahnya dalam projek ini. Setiap larian menyerahkan satu pencarian hingga lima hasil. Kedua berkas tersebut dijalankan secara langsung dengan Node.js; tidak ada langkah build yang diperlukan untuk contoh ini.

#### 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);
```

##### Jalankan · 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);
```

##### Jalankan

```bash
node quickstart.mjs
```



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

### Semak hasil

Status pemeriksaan skrip dilakukan dan mencetak judul sumber, URLs dan kredit yang digunakan. Hasil organik yang kosong adalah valid. Contoh gambar di bawah ini menggambarkan bentuk; sumber hidup akan bervariasi.

| Ukrainian | Guna |
| --- | --- |
| results[].organic[] | Google Search Gelar, link dan snippet. Sumber-sumber lain memiliki muatan yang diketik sendiri. |
| usage.credits | Kredit yang dikenakan untuk permintaan ini; lima hit yang dikembalikan adalah satu permintaan pencarian. |

#### Contoh output

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


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

## Coba sumber data lain

Setiap tab bekerja di kedua TypeScript dan JavaScript. Menggantikan berkas dari langkah 3, menjaga sambungan .mts atau .mjs dan jalankan perintah yang sama. Setiap run adalah permintaan baru dan perlu izin sumber yang ditunjukkan.

### Berita Google

Perlu google_news. Baca entri artikel di 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);
```


### Data meta YouTube

Perlu youtube_metadata. WOVE Kembali judul, saluran, durasi dan rincian video lainnya.

#### 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);
```


### Transkrip YouTube

Perlu youtube_transcript. Permintaan sebuah trek otomatis Inggris yang sudah ada. Teks berada dalam results[].fullText ketika trek tersedia.

#### 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);
```


- [Semua parameter sumber](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/sources/index.md)

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

## Type-check sebuah proyek TypeScript

Wadi Node menjalankan contoh ini dengan mengelupas jenis. Untuk memeriksa tipe tanpa mengirim permintaan, pasang TypeScript dan jalankan kompiler dengan --noEmit:

### Cek jenis opsional

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

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

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

## Apa yang didukung SDK

| Guna | Metode - Metode |
| --- | --- |
| google / youtube | Cari dan ambil data terstruktur dengan bantuan sumber yang diketik. Kau bisa gunakan satu klien untuk melayanimu. |
| youtube.download | Kirimkan audio atau video ke penyimpanan awan Anda melalui pekerjaan latar belakang. Kemudia memerlukan izin youtube_download dan konfigurasi penyimpanan. |
| jobs / bulk | Simpan pekerjaan yang diserahkan IDs dan dapatkan kembali hasil yang selesai. tunggu menunggu di JavaScript; mode: 'async' menyerahkan pekerjaan latar belakang sisi server. |
| account | KISAH, keseimbangan, harga, batas, dan penggunaan yang mudah dibaca sebelum pekerjaan yang berulang. |
| respondWith / accept | { respondWith: 'markdown' } sebagai argumen kedua metode untuk Markdown dalam response.content, atau { accept: 'text/plain' } untuk sebuah string. Objek JSON adalah default. |

- [Contoh unduhan MUSIM](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/examples/youtube_download.mjs)
- [Penyiapan penyimpan barang](https://flashdata.dev/ms/docs/guides/youtube-download-guide/reference.md)
- [Format respons](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/response-formats.md)

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

## Langkah - langkah selanjutnya

- [Simpan hasil dan menangani ralat](https://flashdata.dev/ms/docs/guides/sdk-operations/reference.md)
- [Pekerjaan dan kelompok](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/jobs.md)
- [Konfigurasi klien](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/client.md)
- [Referensi metode SDK](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/api-reference.md)

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

## Jika langkah gagal

| Problem | Fix |
| --- | --- |
| Paket atau runtime hilang | Periksa node --version dan pasang @flashdata-dev/sdk dalam proyek ini. Jaga sambungan .mts atau .mjs di atas. |
| 401 / FLASHDATA_API_KEY | Tetapkan kunci valid di terminal di mana Anda menjalankan contoh. |
| 403 | Hidupkan Google Search untuk kunci API ini. |
| 402 | Cek Billing untuk kredit yang tersedia, atau klaim pengadilan agen yang kelelahan. |
| 429 | Wait untuk Retry-After, kemudian mengurangi permintaan Anda. |
| Kehabisan atau server error | Periksa History sebelum resending; permintaan pertama mungkin sudah berjalan. |

- [Sejarah permintaan](https://flashdata.dev/app/jobs)
- [Billing](https://flashdata.dev/app/billing)
- [Kesalahan dan pemulihan SDK](https://github.com/flashdatadev/flashdata-typescript/blob/v1.1.0/docs/errors.md)
