@cfxlabsinc/b2b-services
    Preparing search index...

    Type Alias ScheduleArgField

    ScheduleArgField: { helpText?: string; label: string; name: string } & (
        | { type: "string"
        | "number" }
        | {
            options: ReadonlyArray<{ label: string; value: string }>;
            type: "select" | "multiselect";
        }
    )

    One operator-editable workflow argument. type drives the input control and validation only — the serialized type of the value comes from the matching key in defaultArgs[0] (see buildWorkflowArgs), because a field can be numeric to a human and still have to reach the workflow as a string. type: "select" / type: "multiselect" add a bounded option set: the operator picks one or several values from options (resolved server-side from the environment), and the server rejects anything outside it.

    Type Declaration

    • OptionalhelpText?: string

      Optional one-line hint rendered under the input.

    • label: string

      Sentence-case field label.

    • name: string

      Key in the workflow's single argument object.

    • { type: "string" | "number" }
      • type: "string" | "number"

        Input affordance + validation: free text, or a finite number.

    • {
          options: ReadonlyArray<{ label: string; value: string }>;
          type: "select" | "multiselect";
      }
      • options: ReadonlyArray<{ label: string; value: string }>

        The permitted values, in display order.

      • type: "select" | "multiselect"

        Input affordance + validation: a bounded pick from options — one value ("select") or several ("multiselect", serialized as an array of the selected option values).

    Settings
    Member Visibility