index.d.ts 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253
  1. /**
  2. * Turn markdown into a syntax tree.
  3. *
  4. * @overload
  5. * @param {Value} value
  6. * @param {Encoding | null | undefined} [encoding]
  7. * @param {Options | null | undefined} [options]
  8. * @returns {Root}
  9. *
  10. * @overload
  11. * @param {Value} value
  12. * @param {Options | null | undefined} [options]
  13. * @returns {Root}
  14. *
  15. * @param {Value} value
  16. * Markdown to parse.
  17. * @param {Encoding | Options | null | undefined} [encoding]
  18. * Character encoding for when `value` is `Buffer`.
  19. * @param {Options | null | undefined} [options]
  20. * Configuration.
  21. * @returns {Root}
  22. * mdast tree.
  23. */
  24. export function fromMarkdown(value: Value, encoding?: Encoding | null | undefined, options?: Options | null | undefined): Root;
  25. /**
  26. * Turn markdown into a syntax tree.
  27. *
  28. * @overload
  29. * @param {Value} value
  30. * @param {Encoding | null | undefined} [encoding]
  31. * @param {Options | null | undefined} [options]
  32. * @returns {Root}
  33. *
  34. * @overload
  35. * @param {Value} value
  36. * @param {Options | null | undefined} [options]
  37. * @returns {Root}
  38. *
  39. * @param {Value} value
  40. * Markdown to parse.
  41. * @param {Encoding | Options | null | undefined} [encoding]
  42. * Character encoding for when `value` is `Buffer`.
  43. * @param {Options | null | undefined} [options]
  44. * Configuration.
  45. * @returns {Root}
  46. * mdast tree.
  47. */
  48. export function fromMarkdown(value: Value, options?: Options | null | undefined): Root;
  49. import type { Value } from 'micromark-util-types';
  50. import type { Encoding } from 'micromark-util-types';
  51. import type { Options } from './types.js';
  52. import type { Root } from 'mdast';
  53. //# sourceMappingURL=index.d.ts.map