metawrite

Mendukung kami

Dapatkan kredit $ 100 gratis di Digitalocean:

Bergabunglah dengan Perselisihan Kami:

---

Metawrite adalah Appwrite SDK dengan komponen siap pakai untuk Svelte / SvelteKit

Paket ini dikelola oleh peningkatan.

Catatan: Versi xxn berarti beberapa perubahan kecil pada dokumentasi atau pengetikan paket.

Versi xnx mungkin termasuk beberapa perubahan kecil. Lihat catatan rilis.

Versi nxx mungkin termasuk beberapa perubahan besar. Lihat catatan rilis.

Info penting

Paket ini sepenuhnya berfungsi dan kompatibel dengan AppWrite Server 0.12, Web SDK 6, dan Sveltekit. Tetapi orang -orang saat ini menghadapi kesulitan dengan npm install metawrite . Kami memiliki template SVELTEKIT yang siap dan dikonfigurasi yang menggunakan Metawrite dan juga dapat digunakan sebagai gambar Docker seperti yang dijelaskan di sini.

Harap pertimbangkan untuk menggunakan template, ini sementara

Dokumentasi

Instalasi

Menggunakan NPM:

npm install metawrite

Menggunakan benang:

yarn add metawrite

Daftar isi

• Mendukung kami
  • Info penting
• Dokumentasi - Instalasi
• Daftar isi
• Penggunaan
  • Inisialisasi
    • Properti
  • Buat Pengguna
    • Arahan
      • Argumen
    • Acara
      • Argumen
      • Argumen
  • Masuk melalui email
    • Arahan
      • Argumen
    • Acara
      • Argumen
      • Argumen
  • Masuk melalui OAuth2
    • Properti
    • Arahan
  • Dapatkan pengguna
    • Arahan
  • Dapatkan koleksi
    • Properti
    • Arahan
      • Argumen
  • Dapatkan dokumen
    • Properti
    • Arahan
      • Argumen
    • Acara
• API
  • Akun
    • <User />
      • Slot
      • Arahan
      • Acara
      • Contoh
    • <Create />
      • Arahan
      • Acara
      • Contoh
    • <Preferences />
      • Slot
      • Arahan
      • Acara
      • Contoh
    • <RecoverPassword />
      • Arahan
      • Acara
      • Contoh
    • <Update />
      • Arahan
      • Acara
      • Contoh
    • <Verification />
      • Arahan
      • Acara
      • Contoh
  • Auth
    • <AuthEmail />
      • Slot
      • Arahan
      • Acara
      • Contoh
    • <AuthOAuth2 />
      • Properti
      • Contoh
    • <CreateAnonymousSession />
      • Arahan
      • Contoh
    • <CreateJWT />
      • Arahan
      • Contoh
    • <MagicURL />
      • Arahan
      • Contoh
  • Avatar
    • <Browser />
      • Argumen
      • Arahan
      • Contoh
    • <CreditCard />
      • Argumen
      • Arahan
      • Contoh
    • <Favicon />
      • Argumen
      • Arahan
    • <Flag />
      • Argumen
      • Arahan
      • Contoh
    • <Image />
      • Argumen
      • Arahan
      • Contoh
    • <QR />
      • Argumen
      • Arahan
      • Contoh
  • Database
    • <Collection />
      • Argumen
      • Slot
      • Arahan
      • Contoh
    • <Document />
      • Argumen
      • Slot
      • Arahan
      • Contoh
  • Realtime - Argumen - Arahan - Contoh
  • Penyimpanan
    • <Storage />
      • Arahan
      • Contoh
    • <FileList />
      • Argumen
      • Slot
      • Arahan
      • Contoh
    • <File />
      • Argumen
      • Arahan
      • Contoh
  • Fungsi
    • <Function />
      • Arahan
      • Slot
      • Contoh
  • Lokal
    • <Continents />
      • Arahan
      • Slot
      • Contoh
    • <Countries />
      • Argumen
      • Slot
      • Arahan
      • Contoh
    • <Currencies />
      • Slot
      • Arahan
      • Contoh
    • <Languages />
      • Slot
      • Arahan
      • Contoh
    • <Locale />
      • Slot
      • Arahan
      • Contoh
    • <PhoneCodes />
      • Slot
      • Arahan
      • Contoh
• Tumpukan

Penggunaan

Anda memerlukan instance AppWrite yang sedang berjalan untuk menggunakan perpustakaan ini. Pergi ke https://appwrite.io/docs/installation untuk instruksi lebih lanjut.

Contoh Psuedo

Tangani beberapa level data relasional async (dan status pemuatan & fallback mereka) sepenuhnya dari markup langsing.

 <!-- 1. ? Appwrite App -->
< Appwrite {... config }>

    <!-- 2. ? Get the current user if logged in -->
    < User let:user >

        < h1 >Hello { user . name }!</ h1 >

        <!-- 3.  Get all the documents from a collection -->
        < Collection collectionId = " 5f56a3035a01f " let:documents >
            You have { documents . length } documents.

            { #each documents as document }

                <!-- 4.  Get a document -->
                < Document collectionId = "5f56a3035a01f" documentId ={ document . $id } { document }>
                    Title: { document . title }
                    Text: { document . text }
...

Inisialisasi

Harus diinisialisasi dan membungkus setiap komponen metawrite .

< script >
	import { Appwrite } from ' metawrite ' ;

	const config = {
		endpoint : ' http://localhost/v1 ' ,
		project : ' demo ' ,
		locale : ' fr '
	};
</ script >

< Appwrite {... config }>...</ Appwrite >

Properti

Nama	Keterangan
endpoint	Titik akhir Appwrite Anda. @type - {string}
project	ID proyek Anda. @type - {string}
locale	Opsional Lokal Pengguna. @type - {string}
realtime	Set Titik Akhir Realtime Kustom Opsional . Secara default sama dengan endpoint . @type - {string}

Buat Pengguna

Mendaftarkan akun baru.

< script >
	import { Create } from ' metawrite ' ;

	let email = ' ' ;
	let password = ' ' ;
	let name = ' ' ;

	const success = ( e ) => {
		// success callback
		// `e` contains the user object
	};

	const failure = ( e ) => {
		// failure callback
	};
</ script >

< Create let:actions on:success on:failure >
	< input type = "text" bind:value ={ email } />
	< input type = "password" bind:value ={ password } />
	< input type = "text" bind:value ={ name } />
	< button on:click ={ actions . create ( email , password , name )}>Register</ button >
</ Create >

Arahan

Biarkan: object Tindakan

Objek dengan fungsi.

Argumen

Nama	Keterangan
create(email, password, name)	Mendaftarkan pengguna baru. @type - {string}

Acara

pada: Sukses

Pemicu pada register yang sukses.

Argumen

Nama	Keterangan
response	Tanggapan

pada: Kegagalan

Pemicu pada register yang gagal.

Argumen

Nama	Keterangan
response	Tanggapan

Masuk melalui email

Masuk melalui email dan kata sandi.

< script >
	import { AuthEmail } from ' metawrite ' ;

	let email = ' ' ;
	let password = ' ' ;

	const success = ( e ) => {
		// success callback
		// `e` contains the user object
	};

	const failure = ( e ) => {
		// failure callback
	};
</ script >

< AuthEmail let:authorize on:success on:failure >
	< input type = "text" bind:value ={ email } />
	< input type = "text" bind:value ={ password } />
	< button on:click ={ authorize ( email , password )}>Login</ button >
</ AuthEmail >

Arahan

Biarkan: function otorisasi

Memulai login.

Argumen

Nama	Keterangan
email	E-mail. @type - {string}
password	Kata sandi. @type - {string}

Acara

pada: Sukses

Memicu login yang sukses.

Argumen

Nama	Keterangan
email	E-mail. @type - {string}

pada: Kegagalan

Memicu login yang gagal.

Argumen

Nama	Keterangan
error	Objek kesalahan.

Masuk melalui OAuth2

Masuk melalui penyedia OAuth2.

< script >
	import { AuthOAuth2 } from ' metawrite ' ;
</ script >

< AuthOAuth2
	authProvider = " google "
	success = " http://localhost:3000?success "
	failure = " http://localhost:3000?failure "
	let:authorize
>
	< button on:click ={ authorize }>Login Google</ button >
</ AuthOAuth2 >

Properti

Nama	Keterangan
authProvider	Penyedia OAuth2. @type - {string}
success	URL Sukses. @type - {string}
failure	URL kegagalan. @type - {string}

Arahan

Biarkan: function otorisasi

Dapatkan pengguna

Meminta pengguna saat ini untuk memeriksa apakah masuk.

< script >
	import { User } from ' metawrite ' ;
</ script >

< User let:user >
	< h1 >Hello { user . name }!</ h1 >
	< div >{ user . email }</ div >

	< div slot = " error " >You are not logged in!</ div >
</ User >

Arahan

Biarkan: object Pengguna

Dapatkan saat ini masuk data pengguna.

Dapatkan koleksi

Dapatkan daftar semua dokumen dari koleksi.

< script >
	import { Collection } from ' metawrite ' ;
</ script >

< Collection collectionId = " 5f56a3035a01f " let:documents >
	You have { documents . length } documents.
</ Collection >

Properti

Nama	Keterangan
collectionId	Koleksi ID Unik. @type - {string}
tambahan	Sama seperti di sini

Arahan

Biarkan: Dokumen array

Array Dokumen.

Biarkan: object Tindakan

Objek dengan fungsi.

Argumen

Nama	Keterangan
reload()	Koleksi re-fetch.
create(data, read, write)	Buat dokumen baru di koleksi. read / write adalah pengguna opsional dan saat ini secara default @type - {string[]} . data adalah @type - {string}

Dapatkan dokumen

Dapatkan dokumen. Jika Anda melewati properti document dengan data, tidak akan ada data yang diminta.

< script >
	import { Document } from ' metawrite ' ;
</ script >

< Document documentId = " 5f56a3asda01f " let:document >
	Title: { document . title }
	Text: { document . text }
</ Document >

Properti

Nama	Keterangan
documentId	Dokumen ID Unik. @type - {string}
collectionId	Koleksi ID Unik. @type - {string}
atau
document	Dokumen disahkan dari <Collection />

Arahan

Biarkan: object Dokumen

Objek JSON dengan data dokumen.

Biarkan: object Tindakan

Objek dengan fungsi.

Argumen

Nama	Keterangan
update(data)	Perbarui dokumen. data adalah @type - {string}
remove()	Menghapus dokumen.
reload()	Dokumen Re-Fetch.

Acara

ON: Ubah

Memicu pembaruan atau hapus login.

API

Akun

Komponen akun memungkinkan Anda untuk mengelola akun pengguna.

<User />

Slot

• memuat
• kesalahan

Arahan

Biarkan: Tindakan

Nama	Keterangan
reload()	Muat ulang.
logout()	Sesi saat ini logout.
logoutAll()	Keluar dari semua sesi.
logoutFrom(session)	Logout dari sesi tertentu. session adalah @type - {string}

• Biarkan: object Pengguna
• Biarkan: Kesalahan

Acara

• ON: Sukses pada kesuksesan pengguna.
• ON: Kegagalan Kegagalan Pengambilan Pengguna.
• ON: SuccessLogout tentang Sukses logout .
• ON: Failurelogout pada kegagalan logout .
• ON: SuccessLogoutFrom pada logoutFrom Sukses.
• ON: FailureLogoutFrom pada kegagalan logoutFrom .
• ON: SuccessLogOutall tentang Sukses logoutAll .
• ON: FailureLogoutall tentang kegagalan logoutAll .

Contoh

< script >
	import { User } from ' metawrite ' ;
</ script >

< User let:actions let:user >
	< button on:click ={ actions . reload ()}>Reload user data</ button >
	< button on:click ={ actions . get ()}>Get logged in user data</ button >
	< button on:click ={ actions . logout ()}>Log out from current session</ button >
	< button on:click ={ actions . logoutFrom ( ' sessionId ' )}>Log out from specific session</ button >
	< button on:click ={ actions . logoutAll ()}>Log out from all sessions</ button >

	<!-- If logged in -->
	< p >Hi, { user . name }</ p >
</ User >

<Create />

Arahan

Biarkan: Tindakan

Nama	Keterangan
create(email, password, name)	Menciptakan pengguna. email dan password diperlukan - @type - {string} . name opsional - @type - {string}

Acara

• ON: Sukses dalam create kesuksesan.
• ON: Kegagalan pada Kegagalan create .

Contoh

< script >
	import { Create } from ' metawrite ' ;

	let name,
		email,
		password = ' ' ;

	const success = ( e ) => {
		// success callback
		// `e` contains the user object
	};

	const failure = ( e ) => {
		// failure callback
	};
</ script >

< Create let:actions on:success on:failure >
	< input type = "text" name = "name" placeholder = "name" bind:value ={ name } />
	< input type = "text" name = "email" placeholder = "email" bind:value ={ email } />
	< input type = "password" name = "password" placeholder = "password" bind:value ={ password } />
	< button on:click ={ actions . create ( name , email , password )}>Create Account</ button >
</ Create >

<Preferences />

Slot

• memuat
• kesalahan

Arahan

Biarkan: Tindakan

Nama	Keterangan
reload()	Memuat ulang preferensi.
update(prefs)	Perbarui preferensi. prefs - @type - {object}

Acara

• ON: Sukses di init dan reload kesuksesan.
• ON: Kegagalan pada init dan reload kegagalan.
• ON: SuccessUpdate tentang Keberhasilan update .
• ON: Kegagalan pada kegagalan update .

Contoh

< script >
	import { Preferences } from ' metawrite ' ;

	let prefs = {
		// You can pass only the specific settings you wish to update.
	};
</ script >

< Preferences let:actions >
	< button
		on:click ={() => {
			actions . update ( prefs );
			actions . reload ();
		}}>Update Preferences</ button
	>
</ Preferences >

<RecoverPassword />

Arahan

Biarkan: Tindakan

Nama	Keterangan
recover(email, url)	Pulihkan Kata Sandi. email dan url diperlukan dan @type - {string} . url adalah halaman Anda di mana Anda akan menangani secret dengan fungsi complete .
complete(user, secret, password, passwordAgain)	Pemulihan Kata Sandi Lengkap. user dan secret diatur secara otomatis oleh metawrite , jadi Anda tidak perlu mengaturnya. password dan passwordAgain diperlukan - @type - {string} .

Acara

• ON: SuccessRecover di init dan reload kesuksesan.
• ON: Failurerecover pada init dan reload kegagalan.
• ON: Success Complete on update Success.
• ON: FailureComplete tentang kegagalan update .

Contoh

< script >
    import { RecoverPassword } from " metawrite " ;

    const url = " http://localhost:3000/reset-password " ; // URL that will point to the next step.
    let email = ' ' ;

    const successRecover = e => {
    // success callback
    // `e` contains the user object
  };

  const failureRecover = e => {
    // failure callback
  }
</ script >

<!-- localhost/forgot-password -->
< RecoverPassword let:actions on:successRecover on:failureRecover >
    < input name = "email" type = "text" bind:value ={ email , url } placeholder = " Email " />
    < button on:click { actions . recover ( email )}>Recover Password</ button >
</ RecoverPassword >

<!-- Then on localhost/reset-password  -->
< script >
    import { RecoverPassword } from " metawrite " ;

    let password, passwordAgain = ' ' ;

    const successComplete = e => {
    // success callback
    // `e` contains the user object
  };

  const failureComplete = e => {
    // failure callback
  }
</ script >

< RecoverPassword let:actions on:successComplete on:failureComplete >
    < input type = "password" name = "password" bind:value { password } placeholder = " Password " />
    < input type = "password" name = "password" bind:value { passwordAgain } placeholder = " Confirm Password " />
    < button on:click { actions . complete ( password , passwordAgain )}>Set New Password</ button >
</ RecoverPassword >

<Update />

Arahan

Biarkan: Tindakan

Nama	Keterangan
name(name)	Perbarui nama. Semua bidang diperlukan. @type - {string}
email(email, password)	Perbarui Email. Semua bidang diperlukan. @type - {string}
password(password, oldPassword)	Perbarui Kata Sandi. Semua bidang diperlukan. @type - {string}

Acara

• ON: SuccessName di name Success.
• ON: Failurename pada kegagalan name .
• ON: Successemail pada kesuksesan email .
• ON: Failemail pada kegagalan email .
• ON: SuccessPassword pada Sukses password .
• ON: FailurePassword pada Kegagalan password .

Contoh

< script >
	import { Update } from ' metawrite ' ;

	let name,
		email,
		password,
		newPassword,
		oldPassword = ' ' ;
</ script >

< Update let:actions >
	< button on:click ={ actions . name ( name )}>This updates name</ button >
	< button on:click ={ actions . email ( email , password )}>This updates email</ button >
	< button on:click ={ actions . password ( newPassword , oldPassword )}>This updates password</ button >
</ Update >

<Verification />

Membuat dan secara otomatis memvalidasi verifikasi email pengguna.

• url tipe string untuk tindakan create harus di mana aplikasi Anda di -host atau localhost .
• Untuk tindakan update , Anda tidak perlu meloloskan apa pun, prosesnya otomatis.

Arahan

Biarkan: Tindakan

Nama	Keterangan
create(url)	Buat verifikasi. url adalah apa yang digunakan URL untuk membuat tautan verifikasi yang dikirim ke kotak masuk email Anda. @type - {string}
update(user, secret)	Verifikasi lengkap. user dan secret diatur secara otomatis oleh metawrite .

Acara

• ON: SuccessCreate on create Success.
• ON: FailureCreate tentang Kegagalan create .
• ON: Success Complete tentang kesuksesan complete .
• ON: FailureComplete pada kegagalan complete .

Contoh

< script >
	import { Verification } from ' metawrite ' ;

	const url = window . location . href ;
</ script >

< Verification let:actions >
	< button on:click ={ actions . create ( url )} />
	< button on:click ={ actions . update ()}>Update email verification status</ button >
</ Verification >

Auth

Komponen auth memungkinkan Anda untuk mengotentikasi akun pengguna.

<AuthEmail />

Slot

• memuat
• kesuksesan
• kesalahan

Arahan

• Let: Otorize (email, kata sandi)
• Biarkan: Pengguna
• Biarkan: Kesalahan

Acara

• ON: Sukses tentang kesuksesan authorize .
• ON: Kegagalan Kegagalan authorize .

Contoh

< script >
	import { AuthEmail } from ' metawrite ' ;

	let email = ' ' ;
	let password = ' ' ;

	const success = ( e ) => {
		// success callback
		// `e` contains the user object
	};

	const failure = ( e ) => {
		// failure callback
	};
</ script >

< AuthEmail let:authorize on:success on:failure >
	< input type = "text" bind:value ={ email } />
	< input type = "text" bind:value ={ password } />
	< button on:click ={ authorize ( email , password )}>Login</ button >
</ AuthEmail >

<AuthOAuth2 />

Properti

Nama	Keterangan
authProvider	Penyedia OAuth2. @type - {string}
success	URL Sukses. @type - {string}
failure	URL kegagalan. @type - {string}
Arahan ####

Biarkan: otorize ()

Contoh

< script >
	import { AuthOAuth2 } from ' metawrite ' ;
</ script >

< AuthOAuth2
	authProvider = " google "
	success = " http://localhost:3000?success "
	failure = " http://localhost:3000?failure "
	let:authorize
>
	< button on:click ={ authorize }>Login Google</ button >
</ AuthOAuth2 >

<CreateAnonymousSession />

Arahan

Biarkan: Tindakan

Nama	Keterangan
create()	Membuat sesi anonim.

Contoh

< script >
	import { CreateAnonymousSession } from ' metawrite ' ;
</ script >

< CreateAnonymousSession let:actions >
	< button on:click ={ actions . create }>Create Anonymous Session</ button >
</ CreateAnonymousSession >

<CreateJWT />

Membuat token JWT.

Arahan

Biarkan: Tindakan

Nama	Keterangan
create()	Membuat token JWT.

Contoh

< script >
	import { CreateJWT } from ' metawrite ' ;
</ script >

< CreateJWT let:actions >
	< button on:click ={ actions . create }>Create JWT token</ button >
</ CreateJWT >

<MagicURL />

Arahan

Biarkan: Tindakan

Nama	Keterangan
create(sessionId, email, url)	Membuat sesi URL ajaib. Email diperlukan, URL adalah untuk menunjuk string langkah lengkap, sessionId tidak diperlukan
complete()	Memvalidasi dan menyelesaikan sesi URL ajaib.

Contoh

< script >
    import { MagicURL } from " metawrite " ;

    let email = " "
    const url = " http://localhost:3000/page-to-complete "

	const successCreate = ( e ) => {
		console . log (e)
	}
	const failureCreate = ( e ) => {
		console . log (e)
	}
	const successComplete = ( e ) => {
		console . log (e)
	}
	const failureComplete = ( e ) => {
		console . log (e)
	}
</ script >

< MagicURL let:actions on:successCreate on:successComplete on:failureCreate on:failureComplete >
		< input type = "email" name = "email" placeholder = "Email" bind:value ={ email } />
		< button on:click ={ actions . create ( email , url )}>Send login link</ button >
		< button on:click ={ actions . complete ()}>Confirm Login</ button >
</ MagicURL >

Avatar

Komponen Avatar bertujuan untuk membantu Anda menyelesaikan tugas sehari -hari yang terkait dengan gambar aplikasi, ikon, dan avatar Anda.

<Browser />

Argumen

• Kode - Diperlukan @type - {string}
• Lebar - Opsional @type - {number}
• Tinggi - Opsional @type - {string}
• Kualitas - Opsional @type - {string}

Arahan

• Biarkan: tautan gambar src @type - {URL}

Contoh

< script >
	import { Browser } from ' metawrite ' ;
</ script >

< Browser code = " firefox " let:src >
	< img src ={ String ( src )} alt = " Browser " />
</ Browser >

<CreditCard />

Argumen

• Kode - Diperlukan @type - {string}
• Lebar - Opsional @type - {number}
• Tinggi - Opsional @type - {string}
• Kualitas - Opsional @type - {string}

Arahan

• Biarkan: tautan gambar src @type - {URL}

Contoh

< script >
	import { CreditCard } from ' metawrite ' ;
</ script >

< CreditCard code = " amex " let:src >
	< img src ={ String ( src )} alt = " card " />
</ CreditCard >

<Favicon />

Argumen

• URL - Diperlukan @type - {string}

Arahan

• Biarkan: tautan gambar src @type - {URL}

< script >
	import { Favicon } from ' metawrite ' ;
	const url = window . location . href ;
</ script >

< Favicon { url } let:src >
	< img src ={ String ( src )} alt = " favicon " />
</ Favicon >

<Flag />

Argumen

• Kode - Diperlukan @type - {string}
• Lebar - Opsional @type - {number}
• Tinggi - Opsional @type - {string}
• Kualitas - Opsional @type - {string}

Arahan

• Biarkan: tautan gambar src @type - {URL}

Contoh

< script >
	import { Flag } from ' metawrite ' ;
</ script >

< Flag code = " canada " let:src >
	< img src ={ String ( src )} alt = " flag " />
</ Flag >

<Image />

Argumen

• URL - Diperlukan @type - {string}
• Lebar - Opsional @type - {number}
• Tinggi - Opsional @type - {number}

Arahan

• Biarkan: tautan gambar src @type - {URL}

Contoh

< script >
	import { Image } from ' metawrite ' ;

	let url = ' https://increas.io/ ' ;
	let width,
		height = 100 ;
</ script >

< Image { url } { width } { height } let:src >
	< img src ={ String ( src )} alt = " someImage " />
</ Image >

<QR />

Argumen

• Teks - Diperlukan @type - {string}
• Ukuran - Opsional @type - {optional}
• margin - opsional @type - {number}
• Unduh - Opsional @type - {boolean}

Arahan

• Biarkan: tautan gambar src @type - {URL}

Contoh

< script >
	import { QR } from ' metawrite ' ;

	let text = ' https://increas.io/ ' ; // could be any text
	let size = 500 ;
	let margin = 1 ;
	let download = false ;
</ script >

< QR { text } { size } { margin } { download } let:src >
	< img src ={ String ( src )} alt = " QR Code " />
</ QR >

Database

Komponen basis data memungkinkan Anda untuk membuat koleksi dokumen terstruktur, kueri dan filter daftar dokumen, dan mengelola serangkaian izin akses baca dan tulis lanjutan.

<Collection />

Argumen

• collectionId - wajib @type - {string}

• cache - opsional , secara default diatur ke false @type - {boolean}

  kueri: @type - {object}

• kueri - opsional @type - {string[]}

• Batas - Opsional @type - {number}

• Offset - Opsional @type - {number}

• Kursor - Opsional @type - {string}

• Cursordirection - Opsional @type - {string}

• OrderAttributes - Opsional @type - {string[]}

• orderTypes - opsional @type - {string[]}

Slot

• memuat
• kesalahan

Arahan

Biarkan: Tindakan

Nama	Keterangan
reload()	Muat ulang.
create(documentId, data, read, write)	Membuat dokumen. data - @type - {string} . read / write adalah opsional @type - {string[]} . documentId adalah opsional, secara default menghasilkan @type - {string} .

• Biarkan: Dokumen
• Biarkan: Kesalahan

Contoh

< script >
  import { Collection } from " metawrite " ;
</ script >

< Collection collectionId = " 5f56a3035a01f " let:documents >
  You have { documents . length } documents.
</ Collection >

<Document />

Argumen

• DocumentId - Diperlukan @type - {string}
• collectionId - wajib @type - {string}

Slot

• memuat
• kesalahan

Arahan

Biarkan: Tindakan

Nama	Keterangan
reload()	Muat ulang.
update(data)	Memperbarui dokumen. data - @type - {object}
remove()	Menghapus dokumen.

• Let: Dokumen
• Biarkan: Kesalahan

Contoh

< script >
	import { Collection , Document } from ' metawrite ' ;

	const collectionId = ' 5f56a3035a01f ' ;
</ script >

< Collection { collectionId } let:documents >
	You have { documents . length } documents:
	{ #each documents as document }
		< Document { collectionId } documentId ={ document . $id } let:document let:actions >
			Title: { document . title }
			Text: { document . text }
			< button on:click ={() => { actions . remove ()}}>Delete</ button >
		</ Document >
	{ /each }
</ Collection >

Waktu nyata

Untuk informasi lebih lanjut tentang penggunaan Realtime di AppWrite, lihat Dokumentasi Realtime.

Realtime memungkinkan Anda untuk mendengarkan acara apa pun di sisi server secara realtime menggunakan metode berlangganan.

Alih -alih meminta data baru melalui HTTP, langganan akan menerima data baru setiap kali berubah, setiap klien yang terhubung menerima pembaruan itu dalam milidetik melalui koneksi WebSocket.

Ini memungkinkan Anda membangun pengalaman pengguna yang interaktif dan responsif dengan memberikan informasi dari semua layanan AppWrite secara realtime.

Argumen

• Saluran - String yang Diperlukan string | string[]

Arahan

Biarkan: Payload - Payload dari langganan akan berisi properti berikut.

Biarkan: Tindakan

Nama	Keterangan
subscribe()	Berlangganan semua pembaruan yang terkait dengan satu atau lebih saluran.
unsubscribe()	Jika Anda tidak lagi ingin menerima pembaruan dari langganan, Anda dapat berhenti berlangganan sehingga panggilan balik Anda tidak lagi dipanggil.

Contoh

< script >
	import { Realtime } from ' metawrite ' ;
</ script >

< Realtime channels = " account " let:actions let:payload >
	< h1 >{ payload . timestamp }</ h1 >
	< button on:click ={ actions . subscribe ()}>Subscribe to Account channel</ button >
	< button on:click ={ actions . unsubscribe ()}>Unsubscribe from Account channel</ button >
</ Realtime >

Penyimpanan

Komponen penyimpanan memungkinkan Anda untuk mengelola file proyek Anda. Anda dapat mengunggah, melihat, mengunduh, dan meminta semua file proyek Anda.

<Storage />

Arahan

Biarkan: Tindakan

Nama	Keterangan
create(bucketId, fileId, file, read, write)	Mengunggah file. fileId diperlukan @type - {string} , "unique()" akan menghasilkan ID unik acak, tetapi Anda dapat menggunakan kustom. file adalah @type - {File} dan diperlukan. read / write adalah @type - {string[]} dan opsional

Contoh

< script lang = " ts " >
    import { Storage } from " metawrite "

    // Required
	let bucketId = " default "
    let file : File ;
    let fileId = " unique() " ; // this will generate random unique id, but you can use custom

    // Optional
    let read : string [];
    let write : string [];
</ script >

< Storage { file } let:actions >
    < button on:click ={ actions . create ( bucketId , fileId , file , read , write )}>Upload File</ button >
</ Storage >

<FileList />

Argumen

• bucketid - wajib @type - {string}
• Cari - Opsional @type - {string}
• Batas - Opsional @type - {number}
• Offset - Opsional @type - {number}
• Kursor - Opsional @type - {string}
• Cursordirection - Opsional @type - {string}
• orderType - opsional @type - {string} => tulis "ASC" atau "DESC"

Slot

• memuat
• kesalahan

Arahan

Biarkan: Tindakan

Nama	Keterangan
reload()	Muat ulang.

• Biarkan: File
• Biarkan: Kesalahan

Contoh

< script >
    import { FileList } from " metawrite "

    // Optional
    let bucketId = ' default ' ;
    let search = ' ' ;
    let limit = 10 ;
    let offset = 0 ;
    let orderType = ' ASC ' ;
</ script >

< FileList { bucketId } { search } { limit } { offset } { orderType } let:actions let:files >
    { #each files as file }
        < p >File: { file . name }</ p >
    { /each }
    < button on:click ={ actions . reload ()}>Reload</ button >
</ FileList >

<File />

Argumen

• Bucketid - Ini adalah ID ember @type - {string}
• FileId - Ini adalah file id @type - {string}

Arahan

Biarkan: Tindakan

Nama	Keterangan
download()	File unduhan.
view()	Dapatkan file untuk dilihat.
preview(width, height, quality, background, output)	Dapatkan file untuk pratinjau.
update(read, write)	Memperbarui file.
delete()	Menghapus file.

Contoh

< script lang = " ts " >
	import { File } from ' metawrite ' ;

	// Required
	let bucketId : string ;
	let fileId : string ;

	// OPTIONAL
	/** @type {number} */ let width;
	/** @type {number} */ let height;
	/** @type {string} */ let gravity;
	/** @type {number} */ let quality;
	/** @type {number} */ let borderWidth;
	/** @type {string} */ let borderColor;
	/** @type {number} */ let borderRadius;
	/** @type {number} */ let opacity;
	/** @type {number} */ let rotation;
	/** @type {string} */ let background;
	/** @type {string} */ let output;
	/** @type {string[]} */ let read;
	/** @type {string[]} */ let write;
</ script >

< File { bucketId } { fileId } let:actions >
	< button on:click ={ actions . download ()}>Download File</ button >
	< button on:click ={ actions . view ()}>File View</ button >
	< button on:click ={ actions . preview ()}>Preview File</ button >
	< button on:click ={ actions . update ( read , write )}>Update File</ button >
	< button on:click ={ actions . delete ()}>Delete File</ button >
</ File >

Fungsi

Layanan Fungsi memungkinkan Anda untuk membuat perilaku khusus yang dapat dipicu oleh acara Sistem AppWrite yang didukung atau dengan jadwal yang telah ditentukan.

Fungsi Cloud AppWrite memungkinkan Anda secara otomatis menjalankan kode backend sebagai tanggapan terhadap peristiwa yang dipicu oleh AppWrite atau dengan mengaturnya untuk dieksekusi dalam jadwal yang telah ditentukan. Kode Anda disimpan dengan cara yang aman pada instance AppWrite Anda dan dieksekusi dalam lingkungan yang terisolasi.

Anda dapat mempelajari lebih lanjut dengan mengikuti tutorial fungsi cloud Appwrite.

<Function />

Arahan

Biarkan: Tindakan

Nama	Keterangan
reload()	Muat ulang.
create(functionId, data)	Menciptakan eksekusi. functionId diperlukan , data bisa menjadi string kosong karena opsional . @type {string}
create(functionId, executionId)	Dapatkan eksekusi. Kedua parameter diperlukan. @type {string}

• Biarkan: Eksekusi

Slot

• kesalahan

Contoh

< script >
	import { Function } from ' metawrite ' ;
	let functionId = ' someExecution ' ; // required
	let newFunctionId = ' ' ;
	let data = ' String of custom data to send to function. ' ; // could be empty string because optional
</ script >

< Function { functionId } { data } let:actions let:executions >
	{ #each executions as execution }
		< p >
			Execution ID: { execution . $id }, Function ID: { execution . functionId }, Date Created: { execution . dateCreated }
		</ p >
	{ /each }
	< input type = "text" name = "functionId" placeholder = "Function ID" bind:value ={ newFunctionId } />
	< button on:click ={ actions . create ( newFunctionId , data )}>Create Execution</ button >
</ Function >

Lokal

Komponen lokal memungkinkan Anda untuk menyesuaikan aplikasi Anda berdasarkan lokasi pengguna Anda.

<Continents />

Arahan

Biarkan: Tindakan

Nama	Keterangan
reload()	Muat ulang.

• Biarkan: benua

Slot

• memuat
• kesalahan

Contoh

< script >
	import { Continents } from ' metawrite ' ;
</ script >

< Continents let:actions let:continents >
	< button on:click ={ actions . reload ()}>Reload</ button >
	< p >There are { continents . sum } continents:</ p >
	{ #each continents . continents as continent }
		< p >{ continent . name }, { continent . code }</ p >
	{ /each }
</ Continents >

<Countries />

Argumen

• UE

Slot

• memuat
• kesalahan

Arahan

Biarkan: Tindakan

Nama	Keterangan
reload()	Muat ulang.

• Biarkan: Negara

Contoh

< script >
	import { Countries } from ' metawrite ' ;

	let eu = true ; // if you want to list only EU countries
</ script >

< Countries let:actions let:countries >
	< button on:click ={ actions . reload ()}>Reload</ button >
	< p >There are { countries . sum } countries in the world:</ p >
	{ #each countries . countries as country }
		< p >{ country . name }, { country . code }</ p >
	{ /each }
</ Countries >

< Countries { eu } let:actions let:countries >
	< button on:click ={ actions . reload ()}>Reload</ button >
	< p >There are { countries . sum } countries in EU:</ p >
	{ #each countries . countries as country }
		< p >{ country . name }, { country . code }</ p >
	{ /each }
</ Countries >

<Currencies />

Slot

• memuat
• kesalahan

Arahan

Biarkan: Tindakan

Nama	Keterangan
reload()	Muat ulang.

• Biarkan: Mata uang

Contoh

< script >
	import { Currencies } from ' metawrite ' ;
</ script >

< Currencies let:actions let:currencies >
	< button on:click ={ actions . reload ()}>Reload</ button >
	< p >There are { currencies . sum } currencies:</ p >
	{ #each currencies . currencies as currency }
		< p >{ currency . symbol } - { currency . name } ({ currency . code })</ p >
	{ /each }
</ Currencies >

<Languages />

Slot

• memuat
• kesalahan

Arahan

Biarkan: Tindakan

Nama	Keterangan
reload()	Muat ulang.

• Biarkan: Bahasa

Contoh

< script >
	import { Languages } from ' metawrite ' ;
</ script >

< Languages let:actions let:languages >
	< button on:click ={ actions . reload ()}>Reload</ button >
	< p >There are { languages . sum } languages:</ p >
	{ #each languages . languages as language }
		< p >{ language . name }, { language . code }></ p >
	{ /each }
</ Languages >

<Locale />

Slot

• memuat
• kesalahan

Arahan

Biarkan: Tindakan

Nama	Keterangan
reload()	Muat ulang.

• Biarkan: object Kode

Contoh

< script >
	import { Locale } from ' metawrite ' ;
</ script >

< Locale let:actions let:code >
	< h1 >Active Session</ h1 >
	< button on:click ={ actions . reload ()}>Reload</ button >
	< p >Location: { code . country }, { code . continentCode }</ p >
	< p >IP: { code . ip }</ p >
</ Locale >

<PhoneCodes />

Slot

• memuat
• kesalahan

Arahan

Biarkan: Tindakan

Nama	Keterangan
reload()	Muat ulang.

• Biarkan: Kode

Contoh

< script >
	import { PhoneCodes } from ' metawrite ' ;
</ script >

< PhoneCodes let:actions let:codes >
	< button on:click ={ actions . reload ()}>Reload</ button >
	< p >There are { codes . sum } phone codes:</ p >
	{ #each codes . phones as phone }
		< p >{ phone . code } - { phone . countyName }></ p >
	{ /each }
</ PhoneCodes >

Tumpukan