Sanity Library Reference Docs
    Preparing search index...

    Function defineSyncTagInvalidateFunction

    • Defines a function that is triggered on a sync tag invalidate event.

      Parameters

      • functionConfig: BlueprintSyncTagInvalidateFunctionConfig

        The configuration for the sync tag invalidate function

        Configuration for defining a sync tag invalidate function.

        • OptionaldisplayName?: string

          Human-readable display name for the function

        • Optionalenv?: Record<string, string>

          Environment variables provided to the function

        • Optionalevent?: BlueprintSyncTagInvalidateFunctionResourceEvent
        • Optionalmemory?: number

          Memory allocation in gigabytes

        • name: string

          The name of the resource. Unique within the blueprint. e.g. 'sync-webhook'

        • Optionalproject?: string

          The project ID of the project that contains your function.

          The project attribute must be defined if your blueprint is scoped to an organization.

        • OptionalrobotToken?: string

          Token provided during function invocation

        • Optionalruntime?: "node" | "nodejs22.x" | "nodejs24.x"

          The runtime environment for the function (currently only Node.js is supported)

          'nodejs24.x'
        • Optionalsrc?: string

          Path to the function source code

          functions/${name}

        • Optionaltimeout?: number

          Execution timeout in seconds

      Returns BlueprintSyncTagInvalidateFunctionResource

      The validated sync tag invalidate function resource

      Using implicit event scoping to all datasets in the function project:

      defineSyncTagInvalidateFunction({
        name: 'bustin-caches',
      })

      Using explicit event scoping to a particular dataset in the function project:

      defineSyncTagInvalidateFunction({
        name: 'bustin-caches',
        event: {
          resource: {
            type: 'dataset',
            id: 'myProj.myDataset',
          },
        },
      })

    Settings

    Member Visibility