/**
 * @file location
 * @module vfile-location/location
 */
import type { Offset } from '@flex-development/unist-util-types';
import type { Indices, Point } from '@flex-development/vfile-location';
import type * as unist from 'unist';
import type { VFile, Value } from 'vfile';
/**
 * Location index.
 *
 * Facilitates conversions between point and offset based locations.
 *
 * @class
 */
declare class Location {
    /**
     * Map, where each key/value pair is either the index of a character in the
     * file ({@linkcode Offset}) and a {@linkcode Point}, or a line and column in
     * the file and an offset.
     *
     * Both the key and value are relative to {@linkcode start}.
     *
     * @see {@linkcode Indices}
     *
     * @public
     * @instance
     * @member {Indices}
     */
    indices: Indices;
    /**
     * Current point.
     *
     * > 👉 Useful for building an incremental index. This point is deeply equal
     * > to {@linkcode start} when a file is auto-indexed and never altered.
     *
     * @see {@linkcode Point}
     *
     * @public
     * @instance
     * @member {Point} place
     */
    place: Point;
    /**
     * Point before first character in file.
     *
     * @see {@linkcode Point}
     *
     * @public
     * @readonly
     * @instance
     * @member {Readonly<Point>} start
     */
    readonly start: Readonly<Point>;
    /**
     * Create a new location index to translate between point and offset based
     * locations in `file`.
     *
     * Pass a `start` point to make relative conversions. Any point or offset
     * accessed will be relative to the given point.
     *
     * An incremental index can be built when `file` is `null` or `undefined`, in
     * which case {@linkcode indices} (and {@linkcode place}) must be updated
     * manually.
     *
     * @see {@linkcode Point}
     * @see {@linkcode VFile}
     * @see {@linkcode Value}
     *
     * @param {Value | VFile | null | undefined} [file] - File to index
     * @param {Point | null | undefined} [start] - Point before first character
     */
    constructor(file?: Value | VFile | null | undefined, start?: Point | null | undefined);
    /**
     * Get an offset for `point`.
     *
     * > 👉 The offset for `point` is greater than or equal to `0` when `point` is
     * > valid, and `-1` when `point` is invalid.
     *
     * @see {@linkcode Offset}
     * @see {@linkcode unist.Point}
     *
     * @public
     * @instance
     *
     * @param {unist.Point | null | undefined} [point] - Place in file
     * @return {Offset} Index of character in file or `-1`
     */
    offset(point?: unist.Point | null | undefined): Offset;
    /**
     * Get a point for `offset`.
     *
     * > 👉 `point.column` and `point.line` are greater than or equal to `1` when
     * > `offset` is valid, and `-1` when `offset` is invalid.
     *
     * @see {@linkcode Offset}
     * @see {@linkcode Point}
     *
     * @public
     * @instance
     *
     * @param {Offset | null | undefined} [offset] - Index of character in file
     * @return {Point} Place in file
     */
    point(offset?: Offset | null | undefined): Point;
}
export default Location;