Skip to content

Interface: ObjectArrayFormulaDef<ParamsT, SchemaT>

core.ObjectArrayFormulaDef

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

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:409


connectionRequirement

Optional Readonly connectionRequirement: ConnectionRequirement

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

Inherited from

Omit.connectionRequirement

Defined in

api_types.ts:401


description

Readonly description: string

A brief description of what the formula does.

Inherited from

Omit.description

Defined in

api_types.ts:375


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:390


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:431


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:396


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.

Inherited from

Omit.isExperimental

Defined in

api_types.ts:415


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.

Inherited from

Omit.isSystem

Defined in

api_types.ts:421


name

Readonly name: string

The name of the formula, used to invoke it.

Inherited from

Omit.name

Defined in

api_types.ts:370


network

Optional Readonly network: Network

Deprecated

use isAction and connectionRequirement instead

Inherited from

Omit.network

Defined in

api_types.ts:404


parameters

Readonly parameters: ParamsT

The parameter inputs to the formula, if any.

Inherited from

Omit.parameters

Defined in

api_types.ts:380


request

request: RequestHandlerTemplate

A definition of the request and any parameter transformations to make in order to implement this formula.

Defined in

api.ts:610


response

response: ResponseHandlerTemplate<SchemaT>

A definition of the schema for the object list returned by this function.

Defined in

api.ts:612


varargParameters

Optional Readonly varargParameters: ParamDefs

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

Inherited from

Omit.varargParameters

Defined in

api_types.ts:385