# Class: FunctionArgument

Class which represent a PostgreSQL {@link Function function} argument. Provides attributes and methods for details of the function argument.

# Hierarchy

  • FunctionArgument

# Properties

# Readonly argumentNumber

argumentNumber: number

Defined in src/pg-structure/function-argument.ts:39

The order number of the argument. It is zero based index.


# Readonly isArray

isArray: boolean

Defined in src/pg-structure/function-argument.ts:30

Whether given argument is an array.


# Readonly mode

mode: ArgumentMode

Defined in src/pg-structure/function-argument.ts:36

Mode of the function arguments such as in, inout, out, variadic or table.


# Readonly name

name: string

Defined in src/pg-structure/function-argument.ts:33

Name of the argument. Empty string if arguments is without a name.


# Readonly type

type: Type

Defined in src/pg-structure/function-argument.ts:27

Type of the argument