Interface: ObjectArrayFormulaDef<ParamsT, SchemaT>¶

Inputs to declaratively define a formula that returns a list of objects. That is, a formula that doesn't require code, which like an EmptyFormulaDef uses a RequestHandlerTemplate to describe the request to be made, but also includes a ResponseHandlerTemplate to describe the schema of the returned objects. These take the place of implementing a JavaScript execute function.

This type is generally not used directly, but describes the inputs to makeTranslateObjectFormula.

Type parameters¶

Name	Type
`ParamsT`	extends `ParamDefs`
`SchemaT`	extends `Schema`

Hierarchy¶

Omit<PackFormulaDef<ParamsT, SchemaType<SchemaT>>, "execute">

↳ ObjectArrayFormulaDef

Properties¶

cacheTtlSecs¶

• Optional Readonly cacheTtlSecs: number

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

Inherited from¶

Omit.cacheTtlSecs

Defined in¶

api_types.ts:316

connectionRequirement¶

• Optional Readonly connectionRequirement: ConnectionRequirement

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

Inherited from¶

Omit.connectionRequirement

Defined in¶

api_types.ts:308

description¶

• Readonly description: string

A brief description of what the formula does.

Inherited from¶

Omit.description

Defined in¶

api_types.ts:282

examples¶

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

Sample inputs and outputs demonstrating usage of this formula.

Inherited from¶

Omit.examples

Defined in¶

api_types.ts:297

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.

Inherited from¶

Omit.extraOAuthScopes

Defined in¶

api_types.ts:338

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.

Inherited from¶

Omit.isAction

Defined in¶

api_types.ts:303

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.