Skip to content

Interface: CommonPackFormulaDef<T>

core.CommonPackFormulaDef

Inputs for creating a formula that are common between regular formulas and sync table formulas.

Type parameters

Name Type
T extends ParamDefs

Hierarchy

  • CommonPackFormulaDef

PackFormulaDef

SyncFormulaDef

Properties

cacheTtlSecs

Optional Readonly cacheTtlSecs: number

How long formulas running with the same values should cache their results for.

Defined in

api_types.ts:440


connectionRequirement

Optional Readonly connectionRequirement: ConnectionRequirement

Does this formula require a connection (aka an account)?

Defined in

api_types.ts:432


description

Readonly description: string

A brief description of what the formula does.

Defined in

api_types.ts:406


examples

Optional Readonly examples: { params: (undefined | PackFormulaValue)[] ; result: PackFormulaResult }[]

Sample inputs and outputs demonstrating usage of this formula.

Defined in

api_types.ts:421


extraOAuthScopes

Optional Readonly extraOAuthScopes: string[]

OAuth scopes that the formula needs that weren't requested in the pack's overall authentication config. For example, a Slack pack can have one formula that needs admin privileges, but non-admins can use the bulk of the pack without those privileges. Coda will give users help in understanding that they need additional authentication to use a formula with extra OAuth scopes. Note that these scopes will always be requested in addition to the default scopes for the pack, so an end user must have both sets of permissions.

Defined in

api_types.ts:462


isAction

Optional Readonly isAction: boolean

Does this formula take an action (vs retrieve data or make a calculation)? Actions are presented as buttons in the Coda UI.

Defined in

api_types.ts:427


isExperimental

Optional Readonly isExperimental: boolean

If specified, the formula will not be suggested to users in Coda's formula autocomplete. The formula can still be invoked by manually typing its full name.

Defined in

api_types.ts:446


isSystem

Optional Readonly isSystem: boolean

Whether this is a formula that will be used by Coda internally and not exposed directly to users. Not for use by packs that are not authored by Coda.

Defined in

api_types.ts:452


name

Readonly name: string

The name of the formula, used to invoke it.

Defined in

api_types.ts:401


network

Optional Readonly network: Network

Deprecated

use isAction and connectionRequirement instead

Defined in

api_types.ts:435


parameters

Readonly parameters: T

The parameter inputs to the formula, if any.

Defined in

api_types.ts:411


varargParameters

Optional Readonly varargParameters: ParamDefs

Variable argument parameters, used if this formula should accept arbitrary numbers of inputs.

Defined in

api_types.ts:416