Modul:CallAssert/doc

Ini adalah sebuah subhalaman dokumentasi untuk Modul:CallAssert.
Templat ini berisi informasi penggunaan, kategori dan konten lainnya yang bukan merupakan bagian dari modul halaman.

Modul ini dinilai siap digunakan secara umum. Modul ini sudah matang dan diperkirakan bebas dari bug dan siap digunakan pada tempat yang tepat di manapun. Modul ini siap disinggung di halaman-halaman bantuan dan sumber informasi Wikipedia lainnya sebagai pilihan untuk dipelajari para pengguna baru. Untuk mengurangi beban server dan output yang tidak diharapkan, modul ini harus diperlengkapi dengan halaman bak pasir dan kasus uji daripada harus melakukan suntingan coba-dan-salah berulang-ulang.

Modul ini menyediakan fungsi callAssert, yang menyederhanakan pemeriksaan kesalahan dengan menampilkan kesalahan jika fungsi yang diberikan mengembalikan nil atau salah. Modul ini mirip dengan fungsi baku assert, tetapi keduanya berbeda, callAssert sendiri memanggil fungsi tersebut, yang nilai kembaliannya akan diperiksa. Memungkinkannya untuk memasukkan nama fungsi dan nilai argumen dalam pesan kesalahan.

Penggunaan

local callAssert = require('Module:CallAssert')
local result1, result2, etc = callAssert(func, 'funcName', ...)

callAssert memangil func(...) dan memeriksa apakah nilai yang dikembalikan pertama bernilai true. Jika ya, maka akan mengembalikan semua nilai yang dikembalikan. Jika tidak, modul ini akan menampilkan pesan kesalahan 'funcName(argument_values) failed'.