unist-util-remove-position

unist utility to remove positions from a tree

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
unist-util-remove-position
1104.0.1a year ago7 years agoMinified + gzip package size for unist-util-remove-position in KB

Readme

unist-util-remove-position
!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sizesize-badgesize !Sponsorssponsors-badgecollective !Backersbackers-badgecollective !Chatchat-badgechat
unistunist utility to remove positionpositions from tree.

Install

This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.
npm install unist-util-remove-position
## Use

```js
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 positionposition fields from nodenode. If force is given, uses delete, otherwise, sets positions to undefined.
Returns
The given node.

Contribute

See contributing.md in syntax-tree/.githubcontributing for ways to get started. See support.mdsupport for ways to get help.
This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MITlicense © Titus Wormerauthor