API referansı
theFinder API referansı
Bu klasör her paketin dışa açtığı API'yi tek tek anlatır. Kurulum ve genel kullanım için kök README'ye bakın.
| Belge | İçerik |
|---|---|
| protocol.md | HTTP protokolü: istek biçimi, tüm komutlar, parametreler, yanıtlar, hata kodları |
| core.md | @thefinder/core: motor, seçenekler, sürücüler, adaptörler, dosya sunucusu, sharp, yardımcılar, tipler |
| client.md | @thefinder/core/client: tarayıcı ve sunucu için API istemcisi |
| next.md | @thefinder/next: route'lar ve proje kökü tespiti |
| react.md | @thefinder/react: <TheFinder />, dosya seçici, özel editörler, store, i18n, tema değişkenleri |
| ckeditor.md | @thefinder/ckeditor: CKEditor 5 eklentisi ve CKEditor 4 connector'ı |
Temel kavramlar#
- Volume: Bir depolama kökü. Her volume bir sürücüye (
localDriver,s3Driverya da kendi sürücünüz) bağlıdır. Birden çok volume aynı anda kullanılabilir. - Volume yolu: Volume içinde
/ile başlayan, normalize edilmiş POSIX yolu:/,/belgeler/rapor.pdf...içeren yollar çözülmeye çalışılmaz, reddedilir. - Kimlik (id):
<volume>_<base64url(yol)>, örneğinfiles_L2RvY3MvYS50eHQ(filesvolume'ünde/docs/a.txt). Kimlikler kalıcıdır, URL'de güvenle kullanılır ve geri çözülebilir:encodeId/decodeId. - Entry: Bir dosya ya da klasörün API'deki temsili. Alanları için core.md › Entry bölümüne bakın.
- Gizli iç klasörler:
.tf-trash(çöp kutusu),.tf-versions(sürüm geçmişi) ve.tf-thumbs(küçük resim önbelleği). Hiçbir komutla, aramayla ya da dosya sunucusuyla erişilemezler; bu adlarla öğe de oluşturulamaz.
Sürümler#
Dört paket her zaman aynı sürüm numarasıyla yayımlanır. 0.x boyunca küçük sürümler (0.1 → 0.2) kırıcı değişiklik içerebilir; değişiklikler her paketin CHANGELOG.md dosyasında listelenir.
Bu sayfa docs/api/tr/README.md dosyasından üretildi.