Interface: OptionalParamDef<T>¶

Marker type for an optional ParamDef, used internally.

Extends¶

ParamDef<T>

Type Parameters¶

Type Parameter
`T` extends `UnionType`

Properties¶

autocomplete?¶

optional autocomplete: MetadataFormula

Defined in: api_types.ts:357

A MetadataFormula that returns valid values for this parameter, optionally matching a search query. This can be useful both if there are a fixed number of valid values for the parameter, or if the valid values from the parameter can be looked up from some API. Use makeMetadataFormula to wrap a function that implements your autocomplete logic. Typically once you have fetched the list of matching values, you'll use autocompleteSearchObjects to handle searching over those values. If you have a hardcoded list of valid values, you would only need to use makeSimpleAutocompleteMetadataFormula.

Inherited from¶

ParamDef.autocomplete

crawlStrategy?¶

optional crawlStrategy: CrawlStrategy

Defined in: api_types.ts:434

Enables crawling for this parameter, where its values are populated from the results of another sync table. Crawling can simplify the user setup when a sync table has a required parameter that can be sourced from another sync.

Crawling is only implemented for sync tables and only during indexing in Superhuman Go.

Example¶

makeParameter({
  type: ParameterType.String,
  name: "project",
  description: "The ID of the project containing the tasks."",
  // Use the project IDs that come from the ID column in the Projects table.
  crawlStrategy: {
    parentTable: {
      tableName: "Projects",
      propertyKey: "id",
    },
  },
}),

See¶

Crawling guide

Inherited from¶

ParamDef.crawlStrategy

defaultValue?¶

optional defaultValue: SuggestedValueType<T>

Defined in: api_types.ts:361

Deprecated¶

This will be removed in a future version of the SDK. Use ParamDef.suggestedValue instead.

Inherited from¶

ParamDef.defaultValue

description¶

description: string

Defined in: api_types.ts:334

A brief description of what this parameter is used for, shown to the user when invoking the formula.

Inherited from¶

ParamDef.description

ingestionSuggestedValue?¶

optional ingestionSuggestedValue: SuggestedValueType<T>

Defined in: api_types.ts:374

The suggested value to be prepopulated for this parameter when used in an ingestion (sync table indexing). This value overrides ParamDef.suggestedValue if set.

Useful in situations where the existing suggested value is used to scope down the synced data to what would fit within Coda's row limits, but during indexing you'd want to include a larger scope of data.