FunctionDeclaration interface

Representasi terstruktur dari deklarasi fungsi seperti yang ditentukan oleh spesifikasi OpenAPI 3.0. Nama fungsi dan parameter disertakan dalam deklarasi ini. FunctionDeclaration ini adalah representasi blok kode yang dapat digunakan sebagai Alat oleh model dan dieksekusi oleh klien.

Tanda Tangan:

export declare interface FunctionDeclaration 

Properti

Properti Jenis Deskripsi
deskripsi string Opsional. Deskripsi dan tujuan fungsi. Model menggunakannya untuk memutuskan bagaimana dan apakah fungsi akan dipanggil atau tidak.
name string Nama fungsi yang akan dipanggil. Harus diawali dengan huruf atau garis bawah. Harus berupa a-z, A-Z, 0-9, atau berisi garis bawah dan tanda hubung, dengan panjang maksimal 64.
parameter FunctionDeclarationSchema Opsional. Menjelaskan parameter ke fungsi ini dalam format Objek Skema JSON. Mencerminkan Objek Parameter Open API 3.03. Nama parameter peka huruf besar/kecil. Untuk fungsi tanpa parameter, parameter ini dapat tidak ditetapkan.

FunctionDeclaration.description

Opsional. Deskripsi dan tujuan fungsi. Model menggunakannya untuk memutuskan bagaimana dan apakah fungsi akan dipanggil atau tidak.

Tanda Tangan:

description?: string;

FunctionDeclaration.name

Nama fungsi yang akan dipanggil. Harus diawali dengan huruf atau garis bawah. Harus berupa a-z, A-Z, 0-9, atau berisi garis bawah dan tanda hubung, dengan panjang maksimal 64.

Tanda Tangan:

name: string;

FunctionDeclaration.parameters

Opsional. Menjelaskan parameter ke fungsi ini dalam format Objek Skema JSON. Mencerminkan Objek Parameter Open API 3.03. Nama parameter peka huruf besar/kecil. Untuk fungsi tanpa parameter, parameter ini dapat tidak ditetapkan.

Tanda Tangan:

parameters?: FunctionDeclarationSchema;