unist-util-remove-position

Build Coverage Downloads Size Sponsors Backers Chat

unist utility to remove positions from tree.

Install

npm:

npm install unist-util-remove-position

Usage

var remark = require('remark')
var removePosition = require('unist-util-remove-position')

var 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

removePosition(node[, force])

Remove positions 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, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer