Skip to content

@pbvex/protocol / FunctionReference

Type Alias: FunctionReference<Type, Args, Return, Visibility>

FunctionReference<Type, Args, Return, Visibility> = object & NoArgsDiscriminator<Args>

A shared reference to a registered PBVex function.

Type Declaration

__args?

optional __args?: Args

__return?

optional __return?: Return

_path

_path: string

_type

_type: Type

_visibility

_visibility: Visibility

Type Parameters

Type

Type extends FunctionType

The function kind (query, mutation, action, httpAction).

Args

Args = any

The (object) arguments to the function.

Return

Return = any

The return type of the function.

Visibility

Visibility extends FunctionVisibility = "public"

Whether the function is public or internal.

Generated API reference. Source of truth is the codebase.