index.d.ts 597 B

1234567891011121314151617181920212223242526
  1. /**
  2. * Remove the `position` field from a tree.
  3. *
  4. * @param {Node} tree
  5. * Tree to clean.
  6. * @param {Options | null | undefined} [options={force: false}]
  7. * Configuration (default: `{force: false}`).
  8. * @returns {undefined}
  9. * Nothing.
  10. */
  11. export function removePosition(
  12. tree: Node,
  13. options?: Options | null | undefined
  14. ): undefined
  15. export type Node = import('unist').Node
  16. /**
  17. * Configuration.
  18. */
  19. export type Options = {
  20. /**
  21. * Whether to use `delete` to remove `position` fields.
  22. *
  23. * The default is to set them to `undefined`.
  24. */
  25. force?: boolean | null | undefined
  26. }