FunctionFragment
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/fragments.d.ts:396
A Fragment which represents a method.
Extends
Section titled “Extends”Properties
Section titled “Properties”constant
Section titled “constant”readonly constant: boolean;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/fragments.d.ts:400
If the function is constant (e.g. pure
or view
functions).
readonly gas: null | bigint;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/fragments.d.ts:417
The recommended gas limit to send when calling this function.
inputs
Section titled “inputs”readonly inputs: readonly ParamType[];
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/fragments.d.ts:231
The inputs for the fragment.
Inherited from
Section titled “Inherited from”readonly name: string;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/fragments.d.ts:274
The name of the fragment.
Inherited from
Section titled “Inherited from”outputs
Section titled “outputs”readonly outputs: readonly ParamType[];
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/fragments.d.ts:404
The returned types for the result of calling this function.
payable
Section titled “payable”readonly payable: boolean;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/fragments.d.ts:413
If the function can be sent value during invocation.
stateMutability
Section titled “stateMutability”readonly stateMutability: "view" | "nonpayable" | "payable" | "pure";
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/fragments.d.ts:409
The state mutability (e.g. payable
, nonpayable
, view
or pure
)
readonly type: FragmentType;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/fragments.d.ts:227
The type of the fragment.
Inherited from
Section titled “Inherited from”Accessors
Section titled “Accessors”selector
Section titled “selector”Get Signature
Section titled “Get Signature”get selector(): string;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/fragments.d.ts:425
The Function selector.
Returns
Section titled “Returns”string
Methods
Section titled “Methods”format()
Section titled “format()”format(format?): string;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/fragments.d.ts:429
Returns a string representation of this function as %%format%%.
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
format? | FormatType |
Returns
Section titled “Returns”string
Overrides
Section titled “Overrides”from()
Section titled “from()”static from(obj): FunctionFragment;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/fragments.d.ts:437
Returns a new FunctionFragment for %%obj%%.
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
obj | any |
Returns
Section titled “Returns”FunctionFragment
Overrides
Section titled “Overrides”getSelector()
Section titled “getSelector()”static getSelector(name, params?): string;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/fragments.d.ts:433
Return the selector for a function with %%name%% and %%params%%.
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
name | string |
params? | any [] |
Returns
Section titled “Returns”string
isConstructor()
Section titled “isConstructor()”static isConstructor(value): value is ConstructorFragment;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/fragments.d.ts:248
Returns true if %%value%% is a [[ConstructorFragment]].
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
value | any |
Returns
Section titled “Returns”value is ConstructorFragment
Inherited from
Section titled “Inherited from”isError()
Section titled “isError()”static isError(value): value is ErrorFragment;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/fragments.d.ts:252
Returns true if %%value%% is an [[ErrorFragment]].
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
value | any |
Returns
Section titled “Returns”value is ErrorFragment
Inherited from
Section titled “Inherited from”isEvent()
Section titled “isEvent()”static isEvent(value): value is EventFragment;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/fragments.d.ts:256
Returns true if %%value%% is an [[EventFragment]].
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
value | any |
Returns
Section titled “Returns”value is EventFragment
Inherited from
Section titled “Inherited from”isFragment()
Section titled “isFragment()”static isFragment(value): value is FunctionFragment;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/fragments.d.ts:442
Returns true
and provides a type guard if %%value%% is a
FunctionFragment.
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
value | any |
Returns
Section titled “Returns”value is FunctionFragment
isFunction()
Section titled “isFunction()”static isFunction(value): value is FunctionFragment;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/fragments.d.ts:260
Returns true if %%value%% is a [[FunctionFragment]].
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
value | any |
Returns
Section titled “Returns”value is FunctionFragment
Inherited from
Section titled “Inherited from”isStruct()
Section titled “isStruct()”static isStruct(value): value is StructFragment;
Defined in: node_modules/.pnpm/ethers@6.15.0/node_modules/ethers/lib.esm/abi/fragments.d.ts:264
Returns true if %%value%% is a [[StructFragment]].
Parameters
Section titled “Parameters”Parameter | Type |
---|---|
value | any |
Returns
Section titled “Returns”value is StructFragment