Variable FunctionArgument

Type Declaration

• getId: function

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

    Returns the id of a non-empty argument.

    Parameters

    • this: void
    • arg: FunctionArgument

    Returns NodeId | undefined

    Example

    foo(a=3, 2) # returns the node id of either `a` or `2`
    Copy

    See

    • FunctionArgument.getReference
    • FunctionArgument.getName

• getName: function

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

    Returns the name of a named argument.

    Parameters

    • this: void
    • arg: FunctionArgument

    Returns string | undefined

    Example

    foo(a = 3, 2) # returns 'a' or undefined
    Copy

    See

    FunctionArgument.getId

• getReference: function

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

    Returns the reference of a non-empty argument.

    Parameters

    • this: void
    • arg: FunctionArgument

    Returns NodeId | undefined

    Example

    foo(a=3, 2) # returns the node id of either `3` or `2`, but skips a
    Copy

    See

    FunctionArgument.getId

• hasName: function

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

    Checks whether the given argument is a named argument with the specified name. Please note that this only checks whether the name is exactly identical and not whether R's argument matching resolves to the correct argument. For this, please refer to the pMatch function!

    Parameters

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

    Returns arg is NamedFunctionArgument

    See

    isNamed

• isEmpty: function

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

    Checks whether the given argument is an empty argument.

    Parameters

    • this: void
    • arg: unknown

    Returns arg is "<>"

    Example

    foo(, 2) # the first argument is empty
    Copy

    See

    isNotEmpty

• isNamed: function

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

    Checks whether the given argument is a named argument.

    Parameters

    • this: void
    • arg: FunctionArgument

    Returns arg is NamedFunctionArgument

    Example

    foo(b=3, 2) # the first argument is named
    Copy

    See

    • isPositional
    • isEmpty
    • hasName

• isNotEmpty: function

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

    Checks whether the given argument is not an empty argument.

    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

    Checks whether the given argument is a positional argument.

    Parameters

    • this: void
    • arg: FunctionArgument

    Returns arg is PositionalFunctionArgument

    Example

    foo(b=3, 2) # the second argument is positional
    Copy

• isUnnamed: function

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

    Checks whether the given argument is an unnamed argument (either positional or empty).

    Parameters

    • this: void
    • arg: FunctionArgument

    Returns arg is "<>" | PositionalFunctionArgument

    Example

    foo(, 2)   # the first argument is unnamed (empty)
    foo(3, 2)  # both arguments are unnamed (positional)
    Copy

    See

    isNamed

• Readonlyname: "FunctionArgument"