Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 1.83 KB

SelectSelectorStep.md

File metadata and controls

37 lines (22 loc) · 1.83 KB

SelectSelectorStep

Picks a subset of the items by count, range, or exact position. The operator determines which additional fields are required: - many selects items from from (start or end) and is limited by count. - between selects items between integer indices from and to. - one selects the single item at index.

Properties

Name Type Description Notes
type TypeEnum A step discriminator of type `select`.
operator OperatorEnum The selection operator applied to the items.
from Object The starting value of the selection. For the `many` operator this is the string `start` or `end`; for the `between` operator this is an integer start index. No discriminator is needed since the string and integer branches are distinguishable by JSON type alone. [optional]
to Integer The end index for the `between` operator. The item at this index is not included. [optional]
count Integer The maximum number of items to select for the `many` operator. [optional]
index Integer The exact position of the item to select for the `one` operator. [optional]
partial Boolean Indicates if the step returns fewer items than requested when the source list is shorter than the range needs. Always `true` for the `many` and `between` operators; not present for `one`, which fails instead of returning a partial result. [optional]

Enum: TypeEnum

Name Value
SELECT "select"

Enum: OperatorEnum

Name Value
MANY "many"
BETWEEN "between"
ONE "one"