Interface: FormulaDef<ParamsT, ResultT, ContextT>¶
Base type for the inputs for creating a formula.
Extends¶
CommonFormulaDef<ParamsT>
Extended by¶
Type Parameters¶
| Type Parameter | Default type |
|---|---|
ParamsT extends ParamDefs |
- |
ResultT extends FormulaResult |
- |
ContextT extends ExecutionContext |
ExecutionContext |
Properties¶
cacheTtlSecs?¶
readonlyoptionalcacheTtlSecs:number
How long formulas running with the same values should cache their results for.
Inherited from¶
connectionRequirement?¶
readonlyoptionalconnectionRequirement:ConnectionRequirement
Does this formula require a connection (aka an account)?
Inherited from¶
CommonFormulaDef.connectionRequirement
description¶
readonlydescription:string
A brief description of what the formula does.
Inherited from¶
examples?¶
readonlyoptionalexamples:object[]
Sample inputs and outputs demonstrating usage of this formula.
params¶
params: (
FormulaValue|undefined)[]
result¶
result:
FormulaResult
Inherited from¶
extraOAuthScopes?¶
readonlyoptionalextraOAuthScopes:string[]
OAuth scopes that the formula needs that weren't requested in the connector's overall authentication config. For example, a Slack connector can have one formula that needs admin privileges, but non-admins can use the bulk of the connector without those privileges. The platform 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 connector, so an end user must have both sets of permissions.
Inherited from¶
CommonFormulaDef.extraOAuthScopes
instructions?¶
readonlyoptionalinstructions:string
Instructions for LLMs to use the formula, overrides the description for LLMs if set.
Inherited from¶
isAction?¶
readonlyoptionalisAction:boolean
Does this formula take an action (vs retrieve data or make a calculation)? Actions are presented as buttons in the Superhuman Docs UI.
Inherited from¶
isExperimental?¶
readonlyoptionalisExperimental:boolean
If specified, the formula will not be suggested to users in the formula autocomplete. The formula can still be invoked by manually typing its full name.
Inherited from¶
CommonFormulaDef.isExperimental
isSystem?¶
readonlyoptionalisSystem:boolean
Whether this is a formula that will be used internally and not exposed directly to users. Not for use by connectors that are not Superhuman-authored.
Inherited from¶
name¶
readonlyname:string
The name of the formula, used to invoke it.
Inherited from¶
network?¶
readonlyoptionalnetwork:Network
Deprecated¶
use isAction and connectionRequirement instead
Inherited from¶
parameters¶
readonlyparameters:ParamsT
The parameter inputs to the formula, if any.
Inherited from¶
validateParameters?¶
optionalvalidateParameters:MetadataFormula<ExecutionContext,ParameterValidationResult>
The JavaScript function that implements parameter validation. This is only allowed on sync formulas.
This function takes in parameters and a context containing a PermissionSyncMode and validates the parameters. A formula may want to validate parameters differently for permissionSyncMode 'PermissionAware' vs 'Personal' vs undefined (which represents a formula).
Example¶
validateParameters: async function (context, _, params) {
let {quantity, sku} = ensureExists(params);
let errors = [];
if (quantity < 0) {
errors.push({message: "Must be a positive number.", propertyName: "quantity"});
}
if (!isValidSku(context, sku)) {
errors.push({message: `Product SKU not found.`, propertyName: "sku"});
}
if (errors.length > 0) {
return {
isValid: false,
message: "Invalid parameter values.",
errors,
};
}
return {
isValid: true,
};
},
Returns¶
Inherited from¶
CommonFormulaDef.validateParameters
varargParameters?¶
readonlyoptionalvarargParameters:ParamDefs
Variable argument parameters, used if this formula should accept arbitrary numbers of inputs.
Only supported in Superhuman Docs.
Inherited from¶
CommonFormulaDef.varargParameters
Methods¶
execute()¶
execute(
params,context):ResultT|Promise<ResultT>
The JavaScript function that implements this formula
Parameters¶
| Parameter | Type |
|---|---|
params |
ParamValues<ParamsT> |
context |
ContextT |
Returns¶
ResultT | Promise<ResultT>