unified

Project: syntax-tree/unist-util-remove-position

Package: unist-util-remove-position@4.0.1

  1. Dependents: 60
  2. unist utility to remove positions from a tree
  1. util 143
  2. utility 139
  3. unist 127
  4. unist-util 25
  5. remove 10
  6. position 9
  7. clean 6
  8. location 4

unist-util-remove-position

Build Coverage Downloads Size Sponsors Backers Chat

unist utility to remove positions from tree.

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-remove-position

Use

import remark from 'remark'
import {removePosition} from 'unist-util-remove-position'

const tree = remark().parse('Some _emphasis_, **importance**, and `code`.')

removePosition(tree, true)

console.dir(tree, {depth: null})

Yields:

{
  type: 'root',
  children: [
    {
      type: 'paragraph',
      children: [
        {type: 'text', value: 'Some '},
        {type: 'emphasis', children: [{type: 'text', value: 'emphasis'}]},
        {type: 'text', value: ', '},
        {type: 'strong', children: [{type: 'text', value: 'importance'}]},
        {type: 'text', value: ', and '},
        {type: 'inlineCode', value: 'code'},
        {type: 'text', value: '.'}
      ]
    }
  ]
}

API

This package exports the following identifiers: removePosition. There is no default export.

removePosition(node[, force])

Remove position fields from node. If force is given, uses delete, otherwise, sets positions to undefined.

Returns

The given node.

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