Variable NodeId

Type Declaration

• ReadonlybuiltInPrefix: "built-in:"

  The prefix used for built-in function or operator ids.

• fromBuiltIn: function

  • fromBuiltIn<T extends string>(this: void, id: `built-in:${T}`): T

    Recovers the built-in function or operator name from a built-in id by removing the built-in prefix.

    Type Parameters

    • T extends string

    Parameters

    • this: void
    • id: `built-in:${T}`

    Returns T

    See

    • isBuiltIn - to check if a given node id is a built-in function or operator id
    • toBuiltIn - to convert a built-in function or operator name to a built-in id

• fromPkgFn: function

  • fromPkgFn<P extends string, F extends string>(
        this: void,
        pkg: P,
        fn: F,
    ): `built-in:${P}:${F}`

    The built-in id of a package's exported function, e.g. fromPkgFn('ggplot2', 'ggplot') yields built-in:ggplot2:ggplot -- toBuiltIn over the pkgFnName pkg:fn form.

    Type Parameters

    • P extends string
    • F extends string

    Parameters

    • this: void
    • pkg: P
    • fn: F

    Returns `built-in:${P}:${F}`

• isBuiltIn: function

  • isBuiltIn(
        this: void,
        id: `built-in:${string}` | NodeId<string | number> | undefined,
    ): id is `built-in:${string}`

    Checks if a given node id is a built-in function or operator id by checking if it is a string that starts with the built-in prefix.

    Parameters

    • this: void
    • id: `built-in:${string}` | NodeId<string | number> | undefined

    Returns id is `built-in:${string}`

    See

    • toBuiltIn - to convert a built-in function or operator name to a built-in id
    • fromBuiltIn - to recover the built-in function or operator name from a built-in id

• mapBuiltInProc: function

  • mapBuiltInProc<T extends BuiltInProcName>(
        this: void,
        proc: T,
    ): T extends `builtin:${S}` ? `built-in:${S}` : `built-in:${T}`

    Converts a built-in function or operator name or id to a built-in id by prefixing it with the built-in prefix if it is not already a built-in id. This allows us to accept both built-in names and ids in contexts where we want to work with built-in ids.

    Type Parameters

    • T extends BuiltInProcName

    Parameters

    • this: void
    • proc: T

    Returns T extends `builtin:${S}` ? `built-in:${S}` : `built-in:${T}`

• Readonlyname: "NodeId"

• normalize: function

  • normalize(this: void, id: NodeId): NodeId

    Normalizes a node id by converting numeric strings to numbers. This allows us to use numeric ids without storing them as strings, while still allowing custom string ids if needed.

    Parameters

    • this: void
    • id: NodeId

    Returns NodeId

• pkgFnName: function

  • pkgFnName<P extends string, F extends string>(
        this: void,
        pkg: P,
        fn: F,
    ): `${P}:${F}`

    The canonical pkg:fn identifier of a package's exported function (e.g. ggplot2:ggplot). The single source of this form: Package.functionIdentifier delegates here, and fromPkgFn wraps it.

    Type Parameters

    • P extends string
    • F extends string

    Parameters

    • this: void
    • pkg: P
    • fn: F

    Returns `${P}:${F}`

• toBuiltIn: function

  • toBuiltIn<T extends string>(this: void, name: T): `built-in:${T}`

    Converts a built-in function or operator name to a built-in id by prefixing it with the built-in prefix.

    Type Parameters

    • T extends string

    Parameters

    • this: void
    • name: T

    Returns `built-in:${T}`

    See

    • isBuiltIn - to check if a given node id is a built-in function or operator id
    • fromBuiltIn - to recover the built-in function or operator name from a built-in id

• toPkgFn: function

  • toPkgFn(
        this: void,
        id: `built-in:${string}` | NodeId<string | number> | undefined,
    ): readonly [string, string] | undefined

    Inverse of fromPkgFn: split a package-function built-in id (built-in:pkg:fn) into its [pkg, fn] parts, or undefined when id is not one (a non-builtin id, or a bare builtin without a package such as built-in:print). A package name never contains a :, so the first one separates it from the function.

    Parameters

    • this: void
    • id: `built-in:${string}` | NodeId<string | number> | undefined

    Returns readonly [string, string] | undefined