site/node_modules/unist-util-position/lib/index.js

96 lines
1.9 KiB
JavaScript
Raw Normal View History

2024-10-14 06:09:33 +00:00
/**
* @typedef {import('unist').Node} Node
* @typedef {import('unist').Point} Point
* @typedef {import('unist').Position} Position
*/
/**
* @typedef NodeLike
* @property {string} type
* @property {PositionLike | null | undefined} [position]
*
* @typedef PositionLike
* @property {PointLike | null | undefined} [start]
* @property {PointLike | null | undefined} [end]
*
* @typedef PointLike
* @property {number | null | undefined} [line]
* @property {number | null | undefined} [column]
* @property {number | null | undefined} [offset]
*/
/**
* Get the ending point of `node`.
*
* @param node
* Node.
* @returns
* Point.
*/
export const pointEnd = point('end')
/**
* Get the starting point of `node`.
*
* @param node
* Node.
* @returns
* Point.
*/
export const pointStart = point('start')
/**
* Get the positional info of `node`.
*
* @param {'end' | 'start'} type
* Side.
* @returns
* Getter.
*/
function point(type) {
return point
/**
* Get the point info of `node` at a bound side.
*
* @param {Node | NodeLike | null | undefined} [node]
* @returns {Point | undefined}
*/
function point(node) {
const point = (node && node.position && node.position[type]) || {}
if (
typeof point.line === 'number' &&
point.line > 0 &&
typeof point.column === 'number' &&
point.column > 0
) {
return {
line: point.line,
column: point.column,
offset:
typeof point.offset === 'number' && point.offset > -1
? point.offset
: undefined
}
}
}
}
/**
* Get the positional info of `node`.
*
* @param {Node | NodeLike | null | undefined} [node]
* Node.
* @returns {Position | undefined}
* Position.
*/
export function position(node) {
const start = pointStart(node)
const end = pointEnd(node)
if (start && end) {
return {start, end}
}
}