Langium - v4.0.0
    Preparing search index...

    Interface JoinOptions<T, U>

    interface JoinOptions<T, U extends T = T> {
        appendNewLineIfNotEmpty?: true | NoOfLineBreaks;
        filter?:
            | ((element: T, index: number, isLast: boolean) => boolean)
            | ((element: T, index: number, isLast: boolean) => element is U);
        prefix?:
            | Generated
            | ((element: U, index: number, isLast: boolean) => Generated);
        separator?: Generated;
        skipNewLineAfterLastItem?: true;
        suffix?:
            | Generated
            | ((element: U, index: number, isLast: boolean) => Generated);
    }

    Type Parameters

    • T
    • U extends T = T
    Index

    Properties

    appendNewLineIfNotEmpty? filter? prefix? separator? skipNewLineAfterLastItem? suffix?

    Properties

    appendNewLineIfNotEmpty?: true | NoOfLineBreaks

    Activates appending of up 6 line breaks after a non-undefined element + suffix + separator if given.

    If true a single line break is appended.

    If a number > 6 is required you can achieve that via the separator or suffix options, e.g. separator: new CompositeGeneratorNode(calcLineBreaks(...)).

    filter?:
        | ((element: T, index: number, isLast: boolean) => boolean)
        | ((element: T, index: number, isLast: boolean) => element is U)

    A plain or type guard filter function.

    Benefit compared to pre-filtering the joined iterable: Original indices of the elements are preserved and forwarded to the toGenerated function.

    prefix?: Generated | ((element: U, index: number, isLast: boolean) => Generated)

    A fixed prefix or prefix computation function to be prepended before each element of the iterable.

    separator?: Generated

    A fixed element separator to be inserted between 2 consecutive non-undefined item representations incl. their suffixes and prefixes.

    skipNewLineAfterLastItem?: true

    Suppresses appending trailing line breaks after the last item in the iterable if activated via appendNewLineIfNotEmpty.

    suffix?: Generated | ((element: U, index: number, isLast: boolean) => Generated)

    A fixed suffix or suffix computation function to be appended after each element of the iterable.

    Settings

    Member Visibility

    On This Page

    Properties