index.d.ts 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. /**
  2. * Get the positional info of `node`.
  3. *
  4. * @param {Node | NodeLike | null | undefined} [node]
  5. * Node.
  6. * @returns {Position | undefined}
  7. * Position.
  8. */
  9. export function position(
  10. node?: Node | NodeLike | null | undefined
  11. ): Position | undefined
  12. /**
  13. * Get the point info of `node` at a bound side.
  14. *
  15. * @param {Node | NodeLike | null | undefined} [node]
  16. * @returns {Point | undefined}
  17. */
  18. export function pointEnd(
  19. node?: Node | NodeLike | null | undefined
  20. ): Point | undefined
  21. /**
  22. * Get the point info of `node` at a bound side.
  23. *
  24. * @param {Node | NodeLike | null | undefined} [node]
  25. * @returns {Point | undefined}
  26. */
  27. export function pointStart(
  28. node?: Node | NodeLike | null | undefined
  29. ): Point | undefined
  30. export type Node = import('unist').Node
  31. export type Point = import('unist').Point
  32. export type Position = import('unist').Position
  33. export type NodeLike = {
  34. type: string
  35. position?: PositionLike | null | undefined
  36. }
  37. export type PositionLike = {
  38. start?: PointLike | null | undefined
  39. end?: PointLike | null | undefined
  40. }
  41. export type PointLike = {
  42. line?: number | null | undefined
  43. column?: number | null | undefined
  44. offset?: number | null | undefined
  45. }