پارامتر¶

مقداری نام‌دار که یک تابع نیاز دارد. برای نمونه، تابع توکار command به یک پارامتر به نام command نیاز دارد. مقادیر پارامتر را روی دکمه وارد می‌کنید.

برخی پارامترها الزامی‌اند؛ بقیه اختیاری هستند و مقدار پیش‌فرضشان در فایل تابع تعریف می‌شود.

فرستادن مقدار از دکمه¶

نام پارامتر را به‌صورت کلیدی مستقیم روی دکمه بنویسید. فیلدهای توکار command، path و args نیز از همین قاعده پیروی می‌کنند و نام پارامترهای سفارشی نیز به همین شکل کار می‌کند.

دادن نام پارامترهای سفارشی

گزارش‌های اخیر سرویس

- name: Nginx logs
  type: button
  function: journal-unit
  unit: "nginx.service"
  lines: 100

unit و lines باید توسط journal-unit تعریف شده باشند. مقدار عددی lines نیازی به نقل‌قول ندارد.

از نگاشت تودرتوی params: استفاده نکنید

فایل تابع سفارشی برای تعریف پارامترهایش از params: استفاده می‌کند، اما دکمه چنین نمی‌کند. host:، unit: یا هر مقدار دیگری را مستقیم روی دکمه بگذارید.

اعتبارسنجی¶

validate بررسی می‌کند که:

هر پارامتر الزامی مقدار داشته باشد؛
هر مقدار روی دکمه توسط تابع آن تعریف شده باشد؛
مقادیر تعریف‌شده با نوع int شامل عدد صحیح باشند؛
مقادیر تعریف‌شده با نوع bool شامل مقدار بولی معتبر باشند؛
مقادیر پیش‌فرض با نوع تعریف‌شدهٔ پارامتر سازگار باشند.

اگر دکمه پارامتر اختیاری را وارد نکند، مقدار پیش‌فرض آن استفاده می‌شود.

نام پارامتر نمی‌تواند با تنظیمات دکمه یکسان باشد: name، type، icon، id، function، confirm، timeout، workdir، env، columns یا items. نام‌های command، path و args مجاز هستند.

برای توضیح کامل و نمونه‌ها، توابع ← فرستادن مقادیر از دکمه را ببینید.

پیکربندی¶

برای تنظیمات دکمه و کلیدهای پارامتر، پیکربندی ← منو را ببینید.

مرتبط¶

تابع — چیزی که از پارامترها استفاده می‌کند
قواعد — قواعد پارامترهای توابع سفارشی