Neverending Pile of Messages

    unist-util-position
    TypeScript icon, indicating that this package has built-in type declarations

    4.0.1 • Public • Published

    unist-util-position

    Build Coverage Downloads Size Sponsors Backers Chat

    unist utility to get the positional info of nodes.

    Install

    This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.

    npm:

    npm install unist-util-position

    Use

    import remark from 'remark'
    import {position, pointStart, pointEnd} from 'unist-util-position'
    
    var tree = remark().parse('# foo\n\n* bar\n')
    
    console.log(position(tree))
    console.log(pointStart(tree))
    console.log(pointEnd(tree))
    
    console.log(position())
    console.log(pointStart())
    console.log(pointEnd())

    Yields:

    {start: {line: 1, column: 1, offset: 0}, end: {line: 4, column: 1, offset: 13}}
    {line: 1, column: 1, offset: 0}
    {line: 4, column: 1, offset: 13}
    {start: {line: null, column: null, offset: null}, end: {line: null, column: null, offset: null}}
    {line: null, column: null, offset: null}
    {line: null, column: null, offset: null}

    API

    This package exports the following identifiers: position, pointStart, and pointEnd. There is no default export.

    position(node?)

    Get the positional info of node (Node?). Returns Position.

    pointStart(node?)

    pointEnd(node?)

    Get the start or end points in the positional info of node (Node?). Returns Point.

    Contribute

    See contributing.md in syntax-tree/.github for ways to get started. See support.md for ways to get help.

    This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

    License

    MIT © Titus Wormer

    Install

    npm i unist-util-position

    DownloadsWeekly Downloads

    1,850,254

    Version

    4.0.1

    License

    MIT

    Unpacked Size

    8.38 kB

    Total Files

    5

    Last publish

    Collaborators

    • avatar
    • avatar