match

import { field, match } from "@toloka-platform/sdk";

const label = field("label", { type: "string" });

export const route = match("route", {
  about: { name: "route" },
  input: [{ field: label, optional: false }],
  conditions: [
    {
      name: "accepted",
      predicates: [
        {
          field: label,
          jsonPath: "$",
          operator: "text_eq",
          value: "accepted",
        },
      ],
    },
  ],
});

console.log(route.matched(0).handle, route.default.handle);

matched_0 default

import { field, match } from "@toloka-platform/sdk";

const label = field("label", { type: "string" });

export const route = match("route", {
  about: { name: "route" },
  input: [{ field: label, optional: false }],
  conditions: [
    {
      name: "accepted",
      predicates: [
        {
          field: label,
          jsonPath: "$",
          operator: "text_eq",
          value: "accepted",
        },
      ],
    },
  ],
});

console.log(route.matched(0).handle, route.default.handle);

matched_0 default

import type { AuthoredMatchNode, AuthoringIdOptions, MatchAuthoringSettings } from "@toloka-platform/sdk";

declare function match(
  name: string,
  settings: MatchAuthoringSettings,
  options?: AuthoringIdOptions,
): AuthoredMatchNode;

Parameters

string

required

Name used to derive the node ID. Also supply settings.about.name.

MatchAuthoringSettings

required

Field bindings and branch conditions. See the Match node reference for routing behavior.

Show Authoring settings

MatchNodeSettings['about']

required

Node name and optional description.

readonly { field: Field; optional: boolean }[]

required

Fields available to conditions. Use declared field objects.

readonly object[]

required

Ordered conditions. Each supplies a name and predicates.

Show Condition properties

string

required

Unique 2–32 character name: lowercase letters, numbers, or underscores; starts with a letter and ends with a letter or number.

'and' | 'or'

default:"and"

How predicates in this condition combine.

readonly object[]

required

Each predicate supplies field: Field, jsonPath: string, operator: "text_eq" | "text_neq", and value: string | number | boolean | null.

AuthoringIdOptions

default:"{}"

Optional identity override.

Show Options

string

Explicit graph node ID. Otherwise derived from the node type and name.

Returns

AuthoredMatchNode

A Match node with compiled field references.

Show Node properties

string

Graph node ID.

'match'

Node type.

MatchNodeSettings

Compiled conditions and input bindings.

InputPort

Port for incoming connections.

OutputPort

Output when no condition matches.

(index: number) => OutputPort

Condition output by zero-based index. matched(0) addresses the first condition. This helper does not check the index bounds.

Throws

Throws a local error for an empty, malformed, too-short, too-long, or duplicate condition name. These are ordinary errors, not PipelineGraphValidationError.

import { field, match } from "@toloka-platform/sdk";

const label = field("label", { type: "string" });

export const route = match("route", {
  about: { name: "route" },
  input: [{ field: label, optional: false }],
  conditions: [
    {
      name: "accepted",
      predicates: [
        {
          field: label,
          jsonPath: "$",
          operator: "text_eq",
          value: "accepted",
        },
      ],
    },
  ],
});

console.log(route.matched(0).handle, route.default.handle);

matched_0 default

Reference

TypeScript SDK

CLI

HTTP API

Parameters

Returns

Throws

​Parameters

​Returns

​Throws

Parameters

Returns

Throws