Type Alias APIDeploymentPayloadScheduledFunction

APIDeploymentPayloadScheduledFunction: {
    export: string;
    handler: string;
    label: string;
    module: string;
    name: string;
    retryOnFail: boolean;
    timeout: number;
}

Type declaration

  • export: string

    The name of the exported function in the "module" to execute the function

  • handler: string

    The relative path including the function name to the file to execute the function

  • label: string

    A human readable label for the function to display

  • module: string

    The relative path to the file to execute the function

  • name: string

    A unique identifier for the function within the scope of the Hosted API

  • retryOnFail: boolean

    If set to true the function will automatically retry if the function fails

  • timeout: number

    The time in seconds allowed for the function to finish executing