Variable FunctionArgument

Type Declaration

• getId: function

  • getId(this: void, arg: FunctionArgument): NodeId | undefined

    The node id of a non-empty arg, e.g. of either a or 2 in foo(a=3, 2).

    Parameters

    • this: void
    • arg: FunctionArgument

    Returns NodeId | undefined

• getName: function

  • getName(this: void, arg: FunctionArgument): string | undefined

    The name of arg if named, undefined otherwise.

    Parameters

    • this: void
    • arg: FunctionArgument

    Returns string | undefined

• getReference: function

  • getReference(this: void, arg: FunctionArgument): NodeId | undefined

    The value node id of a non-empty arg: its own id if positional, or its value's id (skipping the name) if named.

    Parameters

    • this: void
    • arg: FunctionArgument

    Returns NodeId | undefined

• hasName: function

  • hasName(
        this: void,
        arg: FunctionArgument,
        name: string | undefined,
    ): arg is NamedFunctionArgument

    Whether arg is named exactly name (textual match only, not R's argument-matching; see pMatch for that).

    Parameters

    • this: void
    • arg: FunctionArgument
    • name: string | undefined

    Returns arg is NamedFunctionArgument

• isEmpty: function

  • isEmpty(this: void, arg: unknown): arg is "<>"

    Whether arg is the EmptyArgument marker, e.g. the first argument of foo(, 2).

    Parameters

    • this: void
    • arg: unknown

    Returns arg is "<>"

• isNamed: function

  • isNamed(this: void, arg: FunctionArgument): arg is NamedFunctionArgument

    Whether arg is named, e.g. the b=3 in foo(b=3, 2).

    Parameters

    • this: void
    • arg: FunctionArgument

    Returns arg is NamedFunctionArgument

• isNotEmpty: function

  • isNotEmpty<T>(this: void, arg: T): arg is Exclude<T, "<>">

    Type Parameters

    • T

    Parameters

    • this: void
    • arg: T

    Returns arg is Exclude<T, "<>">

    See

    FunctionArgument.isEmpty

• isPositional: function

  • isPositional(
        this: void,
        arg: FunctionArgument,
    ): arg is PositionalFunctionArgument

    Whether arg is positional, e.g. the 2 in foo(b=3, 2).

    Parameters

    • this: void
    • arg: FunctionArgument

    Returns arg is PositionalFunctionArgument

• isUnnamed: function

  • isUnnamed(
        this: void,
        arg: FunctionArgument,
    ): arg is PositionalFunctionArgument | "<>"

    Whether arg is unnamed, i.e. positional or empty, e.g. both arguments of foo(, 2) and foo(3, 2).

    Parameters

    • this: void
    • arg: FunctionArgument

    Returns arg is PositionalFunctionArgument | "<>"

• Readonlyname: "FunctionArgument"