definePortalFunction

definePortalFunction(definition: PortalFunctionDefinition, _contractErrors: PortalFunctionContractErrors<Output, Input>): PortalFunction<Output, Input>

Defines a typed Portal function backed by a versioned host capability. Widgets must include the returned function in defineWidget({ uses: [...] }) before calling it. Inputs and outputs must contain only JSON values.

const getGreeting = definePortalFunction<string>({
  capability: "greeting",
  version: "1",
  method: "get",
});

Parameters

PortalFunctionDefinition

required

Stable capability, version, and method identity.

PortalFunctionContractErrors<Output, Input>

required

Returns

PortalFunction An async worker callable that rejects with PortalFunctionError.

Overview

Task guides

Portal & Widgets

Endpoints

Auth endpoints

Checkout endpoints

Public SDK endpoints

Member endpoints

Payment gateway endpoints

Cart payment endpoints

Commerce endpoints

Webhooks endpoints

Company admin endpoints (v0)

Analytics

definePortalFunction

Parameters

Returns

​Parameters

​Returns

Parameters

Returns