Variable SourceLocation

Type Declaration

• compare: function

  • compare(
        this: void,
        loc1: [
            startLine: number,
            startColumn: number,
            endLine: number,
            endColumn: number,
            f?: string,
        ],
        loc2: [
            startLine: number,
            startColumn: number,
            endLine: number,
            endColumn: number,
            f?: string,
        ],
    ): number

    Parameters

    • this: void
    • loc1: [
          startLine: number,
          startColumn: number,
          endLine: number,
          endColumn: number,
          f?: string,
      ]
    • loc2: [
          startLine: number,
          startColumn: number,
          endLine: number,
          endColumn: number,
          f?: string,
      ]

    Returns number

• format: function

  • format(
        this: void,
        location:
            | [
                startLine: number,
                startColumn: number,
                endLine: number,
                endColumn: number,
                f?: string,
            ]
            | undefined,
    ): string

    Formats a source location as a human-readable string.

    Parameters

    • this: void
    • location:
          | [
              startLine: number,
              startColumn: number,
              endLine: number,
              endColumn: number,
              f?: string,
          ]
          | undefined

    Returns string

• from: function

  • from(
        this: void,
        range: SourceRange,
        file?: string,
    ): [
        startLine: number,
        startColumn: number,
        endLine: number,
        endColumn: number,
        f?: string,
    ]

    Returns the file part of a source location, or undefined if no file is set.

    Parameters

    • this: void
    • range: SourceRange
    • Optionalfile: string

    Returns [
        startLine: number,
        startColumn: number,
        endLine: number,
        endColumn: number,
        f?: string,
    ]

• fromNode: function

  • fromNode<OtherInfo>(
        this: void,
        node: RNode<OtherInfo>,
    ):
        | [
            startLine: number,
            startColumn: number,
            endLine: number,
            endColumn: number,
            f?: string,
        ]
        | undefined

    Creates a source location from a source range and a file name.

    Type Parameters

    • OtherInfo

    Parameters

    • this: void
    • node: RNode<OtherInfo>

    Returns
        | [
            startLine: number,
            startColumn: number,
            endLine: number,
            endColumn: number,
            f?: string,
        ]
        | undefined

    undefined if the given range is undefined

    See

    SourceRange.fromNode for getting the range from an AST node

• getFile: function

  • getFile(
        this: void,
        location: [
            startLine: number,
            startColumn: number,
            endLine: number,
            endColumn: number,
            f?: string,
        ],
    ): string
    | undefined

    Parameters

    • this: void
    • location: [
          startLine: number,
          startColumn: number,
          endLine: number,
          endColumn: number,
          f?: string,
      ]

    Returns string | undefined

• getRange: function

  • getRange(
        this: void,
        location: [
            startLine: number,
            startColumn: number,
            endLine: number,
            endColumn: number,
            f?: string,
        ],
    ): SourceRange

    Returns the source range part of a source location.

    Parameters

    • this: void
    • location: [
          startLine: number,
          startColumn: number,
          endLine: number,
          endColumn: number,
          f?: string,
      ]

    Returns SourceRange

• invalid: function

  • invalid(
        this: void,
    ): [
        startLine: number,
        startColumn: number,
        endLine: number,
        endColumn: number,
        f?: string,
    ]

    Returns an invalid source location (i.e., with an invalid range and no file).

    Parameters

    • this: void

    Returns [
        startLine: number,
        startColumn: number,
        endLine: number,
        endColumn: number,
        f?: string,
    ]

• isSubsetOf: function

  • isSubsetOf(
        this: void,
        loc1: [
            startLine: number,
            startColumn: number,
            endLine: number,
            endColumn: number,
            f?: string,
        ],
        loc2: [
            startLine: number,
            startColumn: number,
            endLine: number,
            endColumn: number,
            f?: string,
        ],
    ): boolean

    Checks if the first location is a subset of the second location. For this, they must be in the same file!

    Parameters

    • this: void
    • loc1: [
          startLine: number,
          startColumn: number,
          endLine: number,
          endColumn: number,
          f?: string,
      ]
    • loc2: [
          startLine: number,
          startColumn: number,
          endLine: number,
          endColumn: number,
          f?: string,
      ]

    Returns boolean

    See

    SourceRange.isSubsetOf

• mapFile: function

  • mapFile(
        this: void,
        loc: [
            startLine: number,
            startColumn: number,
            endLine: number,
            endColumn: number,
            f?: string,
        ],
        fileMapper: (file: string | undefined) => string,
    ): [
        startLine: number,
        startColumn: number,
        endLine: number,
        endColumn: number,
        f?: string,
    ]

    Maps the file part of a source location using the given mapper function.

    Parameters

    • this: void
    • loc: [
          startLine: number,
          startColumn: number,
          endLine: number,
          endColumn: number,
          f?: string,
      ]
    • fileMapper: (file: string | undefined) => string

    Returns [
        startLine: number,
        startColumn: number,
        endLine: number,
        endColumn: number,
        f?: string,
    ]

• merge: function

  • merge(
        this: void,
        locs: (
            | [
                startLine: number,
                startColumn: number,
                endLine: number,
                endColumn: number,
                f?: string,
            ]
            | undefined
        )[],
    ): | [
        startLine: number,
        startColumn: number,
        endLine: number,
        endColumn: number,
        f?: string,
    ]
    | undefined

    Merges multiple source locations into a single source location that spans from the earliest start to the latest end. If the locations are from different files, undefined is returned. Files may be undefined themselves, but if there is at least one defined file, they must all be the same defined file for the merge to succeed.

    Parameters

    • this: void
    • locs: (
          | [
              startLine: number,
              startColumn: number,
              endLine: number,
              endColumn: number,
              f?: string,
          ]
          | undefined
      )[]

    Returns
        | [
            startLine: number,
            startColumn: number,
            endLine: number,
            endColumn: number,
            f?: string,
        ]
        | undefined

• Readonlyname: "SourceLocation"